{ "openapi": "3.0.1", "info": { "title": "Rydoo API", "version": "v2" }, "servers": [ { "url": "https://api.rydoo.com" } ], "paths": { "/v2/approvers/{approverLine}/{approverId}/users": { "get": { "tags": [ "Approver" ], "summary": "Return users of an approver", "operationId": "V2ApproverGetApproverUsersFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverUsersResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Approver" ], "summary": "Replace users of an approver", "operationId": "V2ApproverPutApproverUsersFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UsersApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsersApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsersApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UsersApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update users of an approver", "operationId": "V2ApproverPatchApproverUsersFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/{approverLine}/{approverId}/projects": { "get": { "tags": [ "Approver" ], "summary": "Return projects of an approver", "operationId": "V2ApproverGetApproverProjectsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverProjectsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Approver" ], "summary": "Replace projects of an approver", "operationId": "V2ApproverPutApproverProjects", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update projects of an approver", "operationId": "V2ApproverPatchApproverProjectsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/conflict/{approverLine}/{approverId}/projects": { "get": { "tags": [ "Approver" ], "summary": "Return projects of a conflict approver", "operationId": "V2ApproverGetConflictApproverProjectsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverProjectsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Approver" ], "summary": "Replace projects of a conflict approver", "operationId": "V2ApproverPutConflictApproverProjects", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectsApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update projects of a conflict approver", "operationId": "V2ApproverPatchConflictApproverProjectsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverProjectsAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/{approverLine}/{approverId}/customFieldValues": { "put": { "tags": [ "Approver" ], "summary": "Replace custom field values of an approver", "operationId": "V2ApproverPutApproverCustomFieldValues", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update custom field values of an approver", "operationId": "V2ApproverPatchApproverCustomFieldValues", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Approver" ], "summary": "Return custom field values of an approver", "operationId": "V2ApproverGetApproverCustomFieldsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverCustomFieldValuesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/conflict/{approverLine}/{approverId}/customFieldValues": { "put": { "tags": [ "Approver" ], "summary": "Replace custom field values of a conflict approver", "operationId": "V2ApproverPutConflictApproverCustomFieldValues", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomFieldValuesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Replace custom field values of a conflict approver", "operationId": "V2ApproverPatchConflictApproverCustomFieldValues", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyCustomFieldValuesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Approver" ], "summary": "Return custom field values of a conflict approver", "operationId": "V2ApproverGetConflictApproverCustomFieldsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverCustomFieldValuesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/{approverLine}/{approverId}/groups": { "put": { "tags": [ "Approver" ], "summary": "Replace groups of an approver", "operationId": "V2ApproverPutApproverGroups", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update groups of an approver", "operationId": "V2ApproverPatchApproverGroupsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Approver" ], "summary": "Return groups of an approver", "operationId": "V2ApproverGetApproverGroupsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverGroupsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/conflict/{approverLine}/{approverId}/groups": { "put": { "tags": [ "Approver" ], "summary": "Replace groups of a conflict approver", "operationId": "V2ApproverPutConflictApproverGroups", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupsApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update groups of a conflict approver", "operationId": "V2ApproverPatchConflictApproverGroupsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverGroupsAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Approver" ], "summary": "Return groups of a conflict approver", "operationId": "V2ApproverGetConflictApproverGroupsFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverGroupsResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/{approverLine}/{approverId}/branches": { "get": { "tags": [ "Approver" ], "summary": "Return branches of an approver", "operationId": "V2ApproverGetApproverBranchesFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverBranchesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update branches of an approver", "operationId": "V2ApproverPatchApproverBranchesFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Approver" ], "summary": "Replace branches of an approver", "operationId": "V2ApproverPutApproverBranches", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/approvers/conflict/{approverLine}/{approverId}/branches": { "get": { "tags": [ "Approver" ], "summary": "Return branches of a conflict approver", "operationId": "V2ApproverGetConflictApproverBranchesFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverBranchesResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Approver" ], "summary": "Update branches of a conflict approver", "operationId": "V2ApproverPatchConflictApproverBranchesFromApprovalService", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ModifyApproverBranchesAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Approver" ], "summary": "Replace branches of a conflict approver", "operationId": "V2ApproverPutConflictApproverBranches", "parameters": [ { "name": "approverLine", "in": "path", "required": true, "schema": { "enum": [ "FirstLine", "SecondLine" ], "type": "string" } }, { "name": "approverId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/BranchesApproverAssignment" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps/create": { "post": { "tags": [ "Apps" ], "summary": "Create a new App", "operationId": "V2AppsPostCreate", "requestBody": { "description": "Required fields to create an new App", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateAppRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateAppRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateAppRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateAppRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AppModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps/{id}": { "get": { "tags": [ "Apps" ], "summary": "Get an specific App by Id", "operationId": "V2AppsGet", "parameters": [ { "name": "id", "in": "path", "description": "The App Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AppModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Apps" ], "summary": "Update an App", "operationId": "V2AppsPut", "parameters": [ { "name": "id", "in": "path", "description": "The App Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The required data to update the App", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UpdateAppRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAppRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateAppRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateAppRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AppModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Apps" ], "summary": "Delete an App (soft delete, only disable it)", "operationId": "V2AppsDeleteClient", "parameters": [ { "name": "id", "in": "path", "description": "The App Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AppModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps": { "get": { "tags": [ "Apps" ], "summary": "Get Company Apps", "operationId": "V2AppsGetCompanyApps", "parameters": [ { "name": "limit", "in": "query", "description": "The amount of Apps to retrieve", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The amount of Apps to skip", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchTerm", "in": "query", "description": "Search for an App", "schema": { "type": "string" } }, { "name": "isEnabled", "in": "query", "description": "Include enabled, disabled or all", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_AppOverview" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps/count": { "get": { "tags": [ "Apps" ], "summary": "Get Company Apps count", "operationId": "V2AppsGetCompanyAppsCount", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Search for an App", "schema": { "type": "string" } }, { "name": "isEnabled", "in": "query", "description": "Include enabled, disabled or all", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Int32" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps/{id}/reset-client-secret": { "post": { "tags": [ "Apps" ], "summary": "Reset the App Client Secret", "operationId": "V2AppsPostResetClientSecret", "parameters": [ { "name": "id", "in": "path", "description": "The App Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AppModel" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/apps/scopes": { "get": { "tags": [ "Apps" ], "summary": "Returns a list of Allowed Scopes for Apps", "operationId": "V2AppsGetScopes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ScopesModel" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/audit-checks/external/result": { "post": { "tags": [ "AuditChecks" ], "summary": "Post external audit check result", "operationId": "V2AuditChecksPostExternalAuditCheckResult", "requestBody": { "description": "External audit check result", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalAuditCheckResult" }, "example": {"expenseId":"256847af-8116-4c48-89fe-b78e9b52c24a","correlationId":"e14f9036-502b-4aa1-a5fe-c2de53ac5dac","checkResults":[{"type":"ExpenseIsValid","isViolated":true},{"type":"ExpenseIsInPolicy","isViolated":false}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalAuditCheckResult" }, "example": {"expenseId":"256847af-8116-4c48-89fe-b78e9b52c24a","correlationId":"e14f9036-502b-4aa1-a5fe-c2de53ac5dac","checkResults":[{"type":"ExpenseIsValid","isViolated":true},{"type":"ExpenseIsInPolicy","isViolated":false}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalAuditCheckResult" }, "example": {"expenseId":"256847af-8116-4c48-89fe-b78e9b52c24a","correlationId":"e14f9036-502b-4aa1-a5fe-c2de53ac5dac","checkResults":[{"type":"ExpenseIsValid","isViolated":true},{"type":"ExpenseIsInPolicy","isViolated":false}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalAuditCheckResult" }, "example": {"expenseId":"256847af-8116-4c48-89fe-b78e9b52c24a","correlationId":"e14f9036-502b-4aa1-a5fe-c2de53ac5dac","checkResults":[{"type":"ExpenseIsValid","isViolated":true},{"type":"ExpenseIsInPolicy","isViolated":false}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/bankaccounts": { "get": { "tags": [ "BankAccounts" ], "summary": "Get bank accounts in your company", "operationId": "V2BankAccountsGetBankAccounts", "parameters": [ { "name": "limit", "in": "query", "description": "The number of bank accounts to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of bank accounts to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filter by the categories where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_BankAccount" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/branches": { "get": { "tags": [ "Branch" ], "summary": "Get branches in the company", "operationId": "V2BranchGetBranches", "parameters": [ { "name": "limit", "in": "query", "description": "The number of branches to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of branches to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the branches list", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filter on the branches where the name or ID contain this string", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active branches (all branches are retrieved by default)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_BranchSummary" }, "example": {"data":[{"id":"61c8aa21-b7d5-49b2-95c0-d5c262f18ba3","name":"test_33","enterpriseNumber":"en_33","currency":"EUR","country":"BEL"},{"id":"05db1daf-8325-4cba-a9ed-c97080359842","name":"test_175","enterpriseNumber":"en_175","currency":"EUR","country":"BEL"}],"links":{"next":"/v2/branches?limit=2&offset=2","count":"/v2/branches/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/branches/count": { "get": { "tags": [ "Branch" ], "summary": "Get total count of the branches in the company", "operationId": "V2BranchGetCount", "parameters": [ { "name": "search", "in": "query", "description": "Filter on the branches where the name contain this string", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active branches (all branches are retrieved by default)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/branches/{branchId}": { "get": { "tags": [ "Branch" ], "summary": "Get company branch by its unique identifier", "operationId": "V2BranchGetBranch", "parameters": [ { "name": "branchId", "in": "path", "description": "Unique identifier of the branch", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Branch" }, "example": {"data":{"id":"b46f470d-ed86-4d3b-9f9f-79d4dbef977c","name":"test_13","timeOffset":"-04:00","enterpriseNumber":"enum_13","refId":"ref_13","currency":"EUR","address":{"street":"Street","postalCode":"OOO","city":"City","country":"USA"}},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/businessunits": { "get": { "tags": [ "BusinessUnits" ], "summary": "Get the business units in your company", "operationId": "V2BusinessUnitsGetBusinessUnits", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_BusinessUnit" }, "example": {"data":[{"id":"daf86a77-b169-46b7-9aa8-69da48956109","name":"string"},{"id":"519579be-9f65-4882-91f7-7430bdd489e6","name":"string"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cash-advances/closed": { "get": { "tags": [ "CashAdvance" ], "summary": "Get closed cash advances for your company", "operationId": "V2CashAdvanceGetClosedAdvances", "parameters": [ { "name": "limit", "in": "query", "description": "The number of cash-advances to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of cash-advances to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CashAdvance" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cash-advances/waitingPayment": { "get": { "tags": [ "CashAdvance" ], "summary": "Get waiting payment cash advances for your company", "operationId": "V2CashAdvanceGetWaitingPaymentAdvances", "parameters": [ { "name": "limit", "in": "query", "description": "The number of cash-advances to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of cash-advances to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CashAdvance" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cash-advances/paid": { "get": { "tags": [ "CashAdvance" ], "summary": "Get paid cash advances for your company", "operationId": "V2CashAdvanceGetPaidAdvances", "parameters": [ { "name": "limit", "in": "query", "description": "The number of cash-advances to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of cash-advances to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CashAdvance" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/cash-advances/{cashAdvanceId}/paid": { "put": { "tags": [ "CashAdvance" ], "summary": "Set a cash-advance to Paid", "operationId": "V2CashAdvanceSetPaid", "parameters": [ { "name": "cashAdvanceId", "in": "path", "description": "Cash Advance Id", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "PaymentReference", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetPaidRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetPaidRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetPaidRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetPaidRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SetPaidResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/categories": { "get": { "tags": [ "Categories" ], "summary": "Get the categories of your company", "operationId": "V2CategoriesGetCategories", "parameters": [ { "name": "limit", "in": "query", "description": "The number of categories to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of categories to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active categories (default is all categories)", "schema": { "type": "boolean" } }, { "name": "loadAllLevels", "in": "query", "description": "Return all levels of categories or just the root level (unless when filtering by parentCategoryId)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the categories where the name contain this string", "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchIds", "in": "query", "description": "", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "parentCategoryId", "in": "query", "description": "", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CategorySummary" }, "example": {"data":[{"id":"a51cc6f4-ec1e-428f-b8ab-fcfb2b2cde35","name":"test_244","isActive":true,"accountingNumber":"acc_244","branchName":"branch_244","hasChildren":false},{"id":"e4e8da03-2402-4f84-8076-b144f17308f3","name":"test_3","isActive":true,"accountingNumber":"acc_3","branchName":"branch_3","hasChildren":false}],"links":{"next":"/v2/categories?limit=1&offset=2&sort=Name&isActive=true&search=a&branchId=1a7ee5b8-f803-4e03-998d-d3d9552f391c&parentCategoryId=3a412bf5-f9cf-4478-831c-6938e529eda5","count":"/v2/categories/count?sort=Name&isActive=true&search=a&branchId=9a41a4cb-23fd-4e82-8637-2292e94a7dc3&parentCategoryId=ad9a1fe5-1c44-4ee8-a8b7-509a2ba50ffa"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Categories" ], "summary": "Add a category to the company", "operationId": "V2CategoriesAddCategory", "requestBody": { "description": "The information of the category to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Category" }, "example": {"data":{"id":"1c4b3c01-9b5c-4594-95b8-3fa6a442361e","name":"test_1","isActive":true,"accountingNumber":"an_1","secondaryAccountingNumber":"san_1","branch":{"id":"776e7a6b-e22d-4766-8e23-c9ec0ec8861a","name":"branch_107","refId":"ref_107"},"parentCategory":{"id":"8ff60911-35e3-41a3-9588-d595c7970952","name":"categ_17","refId":"ref_17"},"isCommentFieldRequired":false,"defaultForExpenseTypes":null,"limitedToExpenseTypes":null,"limitedToGroups":[]},"messages":[{"code":0,"message":"category successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/categories/count": { "get": { "tags": [ "Categories" ], "summary": "Get the total count of the categories in your company", "operationId": "V2CategoriesGetCount", "parameters": [ { "name": "search", "in": "query", "description": "Filter on the categories where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/categories/{categoryId}": { "get": { "tags": [ "Categories" ], "summary": "Get the specified category", "operationId": "V2CategoriesGetCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "Unique identifier of the category", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Category" }, "example": {"data":{"id":"fba321a0-8660-4704-9d3f-fd3fc2051232","name":"test_160","isActive":true,"accountingNumber":"an_160","secondaryAccountingNumber":"san_160","branch":{"id":"976b2835-39db-4d04-99e3-908822600478","name":"branch_53","refId":"ref_53"},"parentCategory":{"id":"789e4a0c-f0bf-4795-9d8c-778de6176e92","name":"categ_12","refId":"ref_12"},"isCommentFieldRequired":false,"defaultForExpenseTypes":null,"limitedToExpenseTypes":null,"limitedToGroups":[]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Categories" ], "summary": "Update a category", "operationId": "V2CategoriesEditCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "The unique identifier of the category", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the category with", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CategoryChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Category" }, "example": {"data":{"id":"29999e4d-3598-41cb-bad8-889ceeedfdac","name":"test_77","isActive":true,"accountingNumber":"an_77","secondaryAccountingNumber":"san_77","branch":{"id":"6323d46d-f3c1-4623-8a47-f55f18b6de82","name":"branch_109","refId":"ref_109"},"parentCategory":{"id":"05041651-44d1-4741-b4b0-e66266efa2c5","name":"categ_81","refId":"ref_81"},"isCommentFieldRequired":false,"defaultForExpenseTypes":null,"limitedToExpenseTypes":null,"limitedToGroups":[]},"messages":[{"code":0,"message":"category successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Categories" ], "summary": "Patch a category", "operationId": "V2CategoriesPatchEditCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "The unique identifier of the category", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to patch the category with", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Category" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Categories" ], "summary": "Delete a category", "operationId": "V2CategoriesDeleteCategory", "parameters": [ { "name": "categoryId", "in": "path", "description": "The unique identifier of the category", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Result" }, "example": {"messages":[{"code":0,"message":"category successfully deleted"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/clients": { "get": { "tags": [ "Clients" ], "summary": "Get clients", "operationId": "V2ClientsGetClients", "parameters": [ { "name": "searchTerm", "in": "query", "description": "Word used to search by clients", "schema": { "type": "string" } }, { "name": "isEnabled", "in": "query", "description": "The client state", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ClientOverview" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Clients" ], "summary": "Create the client", "operationId": "V2ClientsAddClient", "requestBody": { "description": "The client information", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ClientInputModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ClientInputModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ClientInputModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ClientInputModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Client" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/clients/{id}": { "get": { "tags": [ "Clients" ], "summary": "Get the speciified client", "operationId": "V2ClientsGetClientById", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the client", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Client" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Clients" ], "summary": "Update the client", "operationId": "V2ClientsEditClient", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the client", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The client information", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Client" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/clients/{clientId}": { "get": { "tags": [ "Clients" ], "summary": "Get the speciified client", "operationId": "V2ClientsGetClientByClientId", "parameters": [ { "name": "clientId", "in": "path", "description": "Unique ID of the client", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Client" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get custom fields", "operationId": "V2CompanyCustomFieldsGetCustomFields", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CompanyCustomFieldSummary" }, "example": {"data":[{"id":"54988797-2053-4016-b19d-b0b05ce03767","name":"Cost Center","usedIn":["RegularExpense","Mileage","PerDiem"],"type":"List","status":"Active"},{"id":"ace87304-59d2-4f09-bf36-08cf6a428f60","name":"Additional Info","usedIn":["Project"],"type":"Text","status":"Active"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/{customFieldId}": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get the specific custom field", "operationId": "V2CompanyCustomFieldsGetCustomField", "parameters": [ { "name": "customFieldId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CompanyCustomField" }, "example": {"data":{"id":"44b43e0f-6dc8-4798-8f68-e174c2389ae4","name":"Office Location","externalId":"OFF_LOC","usedIn":["RegularExpense","Mileage","PerDiem"],"type":"List","required":true,"status":"Active","limitations":{"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]},"reportingFilter":false,"readOnly":false},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/{customFieldId}/limitations": { "put": { "tags": [ "CompanyCustomFields" ], "summary": "Update limitations of a custom field", "operationId": "V2CompanyCustomFieldsUpdateCustomFieldLimitations", "parameters": [ { "name": "customFieldId", "in": "path", "description": "Unique identifier of the custom field", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The edited limitations", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CustomFieldLimitations" }, "example": {"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/CustomFieldLimitations" }, "example": {"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomFieldLimitations" }, "example": {"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CustomFieldLimitations" }, "example": {"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CompanyCustomField" }, "example": {"data":{"id":"38da5535-687e-4607-be1d-f7387527bf19","name":"Office Location","externalId":"OFF_LOC","usedIn":["RegularExpense","Mileage","PerDiem"],"type":"List","required":true,"status":"Active","limitations":{"roles":["Approver","Controller","Finance"],"branches":["3fa85f64-5717-4562-b3fc-2c963f66afa6","f32d7ca2-4d04-4e2e-b141-e3762e674ed8"],"categories":["c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","1c30fa79-aad1-4cca-ae22-1cbd6a86207c"]},"reportingFilter":false,"readOnly":false},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/limitations/role-combinations": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get valid role combinations for custom fields", "operationId": "V2CompanyCustomFieldsGetValidRoleCombinations", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CustomFieldRoleCombinations" }, "example": {"data":{"roleCombinations":[["Approver","Controller","Finance"],["Controller","Finance"],["Finance"]]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/limitation-chains": { "post": { "tags": [ "CompanyCustomFields" ], "summary": "Create a limitation chain between custom field list items", "operationId": "V2CompanyCustomFieldsAddLimitationChain", "requestBody": { "description": "The limitations that make up the chain", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateLimitationChain" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateLimitationChain" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateLimitationChain" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateLimitationChain" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/limitation-chains/search": { "post": { "tags": [ "CompanyCustomFields" ], "summary": "Search limitation chains matching the given limitations", "operationId": "V2CompanyCustomFieldsSearchLimitationChains", "requestBody": { "description": "The limitations to search by", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SearchLimitationChains" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/SearchLimitationChains" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/SearchLimitationChains" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SearchLimitationChains" }, "example": {"limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_LimitationChain" }, "example": {"data":[{"id":"905ed561-df26-401e-9a9e-9fca65f74f0f","limitations":[{"customField":"c8c3b43f-d0d7-4bc5-9f85-c30e6fee47aa","condition":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},{"customField":"1c30fa79-aad1-4cca-ae22-1cbd6a86207c","condition":"f32d7ca2-4d04-4e2e-b141-e3762e674ed8"}]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/limitation-chains/{chainId}": { "delete": { "tags": [ "CompanyCustomFields" ], "summary": "Delete a limitation chain", "operationId": "V2CompanyCustomFieldsDeleteLimitationChain", "parameters": [ { "name": "chainId", "in": "path", "description": "Unique identifier of the limitation chain", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/{customFieldId}/listitems": { "post": { "tags": [ "CompanyCustomFields" ], "summary": "Add a list item to the custom field", "operationId": "V2CompanyCustomFieldsAddListItem", "parameters": [ { "name": "customFieldId", "in": "path", "description": "Unique identifier of the custom field", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List item to add to the custom field", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get list items defined for a given custom field", "operationId": "V2CompanyCustomFieldsGetCustomFieldListItems", "parameters": [ { "name": "customFieldId", "in": "path", "description": "Unique identifier of the custom field", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filter on list items where name or external ID begins with this string", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of list items to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of list items to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "searchMode", "in": "query", "description": "Determines whether the search uses prefix matching or exact name or external ID matching", "schema": { "enum": [ "FuzzySearch", "ExternalIdExactSearch", "NameExactSearch" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ListItemSummary" }, "example": {"data":[{"id":"2ad21b92-b010-41f8-bf32-35c32016e8fe","name":"name_1","externalId":"ext1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166"},{"id":"32f7ca2a-3fb0-41cf-847e-a0544c1e99d8","name":"name_1","externalId":"ext2","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166"}],"links":{"next":"/v2/company/customfields/b094b976-8319-4839-88cd-914762bfc836/listitems?limit=2&offset=4","count":"/v2/company/customfields/b094b976-8319-4839-88cd-914762bfc836/listitems/"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/listitems/{listItemId}": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get a list item of a custom field", "operationId": "V2CompanyCustomFieldsGetCustomFieldListItem", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCompanyCustomFieldListItem" }, "example": {"data":{"id":"99d4dda4-70ef-4874-a18d-76e11b616253","name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyCustomFields" ], "summary": "Update a list item of a custom field", "operationId": "V2CompanyCustomFieldsUpdateCustomFieldListItem", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The edited list item body", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "text/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CompanyCustomFieldListItem" }, "example": {"name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCompanyCustomFieldListItem" }, "example": {"data":{"id":"19e7b5f7-d8d6-4a3d-b3cc-a980ad8e07dc","name":"name_1","externalId":"ext_1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166","limitations":{"branchId":"9effbbb7-4a52-4812-a6b8-25acc40cf718","projectId":"fc80e081-3dfb-4390-ba63-a33df502494a"},"defaultFor":{"groups":{"all":false,"ids":["006e2c1a-bf73-495a-ad0e-5a1c37189a1e","1d4f2cbd-9759-4baa-8adf-00769218af49"]}}},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/listitems/{listItemId}/users": { "patch": { "tags": [ "CompanyCustomFields" ], "summary": "Assign users who can view a list item of a custom field", "operationId": "V2CompanyCustomFieldsPatchListItemUsers", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User assignments collection", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignment" } }, "example": [{"userId":"c08084bc-f323-4d84-af55-08d801a11166","startDate":"2020-06-23","endDate":"2020-08-23"},{"userId":"99d319f0-c986-4685-b834-08d807e21c71","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignment" } }, "example": [{"userId":"c08084bc-f323-4d84-af55-08d801a11166","startDate":"2020-06-23","endDate":"2020-08-23"},{"userId":"99d319f0-c986-4685-b834-08d807e21c71","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignment" } }, "example": [{"userId":"c08084bc-f323-4d84-af55-08d801a11166","startDate":"2020-06-23","endDate":"2020-08-23"},{"userId":"99d319f0-c986-4685-b834-08d807e21c71","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignment" } }, "example": [{"userId":"c08084bc-f323-4d84-af55-08d801a11166","startDate":"2020-06-23","endDate":"2020-08-23"},{"userId":"99d319f0-c986-4685-b834-08d807e21c71","startDate":"2020-06-22","endDate":"2020-08-22"}] } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkMultiResult_Of_ListItemUserAssignmentBulkResult" }, "example": {"data":[{"status":"Added","error":null,"warning":null,"userId":"c08084bc-f323-4d84-af55-08d801a11166","startDate":"2020-06-23","endDate":"2020-08-23"},{"status":"Updated","error":null,"warning":null,"userId":"99d319f0-c986-4685-b834-08d807e21c71","startDate":"2020-06-22","endDate":"2020-08-22"}],"totalItemsCount":2,"totalItemsErrors":0,"totalItemsWarnings":0,"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "CompanyCustomFields" ], "summary": "Unassign all users from a list item of a custom field", "operationId": "V2CompanyCustomFieldsDeleteListItemUsers", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get a list of user assignments defined for a given list item", "operationId": "V2CompanyCustomFieldsGetListItemUserAssignments", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of user assignments to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of user assignments to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ListItemUserAssignment" }, "example": {"data":[{"userId":"9ff7a1b9-8f35-45c2-96eb-4a9d2203df11","startDate":"2020-01-01","endDate":"2025-12-31"},{"userId":"9c6be1bb-b8bb-4d20-9d16-4e32de06b5b2","startDate":"2020-01-01","endDate":"2025-12-31"}],"links":{"next":"/v2/company/customfields/listitems/2bc4f220-c950-4a20-9731-38c601d1d265/users?limit=2&offset=4"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/users/{userId}/listitems": { "patch": { "tags": [ "CompanyCustomFields" ], "summary": "Assign list items of a custom field that can be viewed by a user", "operationId": "V2CompanyCustomFieldsPatchUserListItems", "parameters": [ { "name": "userId", "in": "path", "description": "Unique identifier of the user", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List item assignments collection", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItemAssignment" } }, "example": [{"listItemId":"cbed7f2b-4de8-43a9-a218-b4e6cbde3dce","startDate":"2020-06-23","endDate":"2020-08-23"},{"listItemId":"5fb677e3-3f8d-451b-a38f-7537bad10c0b","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItemAssignment" } }, "example": [{"listItemId":"cbed7f2b-4de8-43a9-a218-b4e6cbde3dce","startDate":"2020-06-23","endDate":"2020-08-23"},{"listItemId":"5fb677e3-3f8d-451b-a38f-7537bad10c0b","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItemAssignment" } }, "example": [{"listItemId":"cbed7f2b-4de8-43a9-a218-b4e6cbde3dce","startDate":"2020-06-23","endDate":"2020-08-23"},{"listItemId":"5fb677e3-3f8d-451b-a38f-7537bad10c0b","startDate":"2020-06-22","endDate":"2020-08-22"}] }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItemAssignment" } }, "example": [{"listItemId":"cbed7f2b-4de8-43a9-a218-b4e6cbde3dce","startDate":"2020-06-23","endDate":"2020-08-23"},{"listItemId":"5fb677e3-3f8d-451b-a38f-7537bad10c0b","startDate":"2020-06-22","endDate":"2020-08-22"}] } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkMultiResult_Of_UserListItemAssignmentBulkResult" }, "example": {"data":[{"status":"Added","error":null,"warning":null,"listItemId":"cbed7f2b-4de8-43a9-a218-b4e6cbde3dce","startDate":"2020-06-23","endDate":"2020-08-23"},{"status":"Updated","error":null,"warning":null,"listItemId":"5fb677e3-3f8d-451b-a38f-7537bad10c0b","startDate":"2020-06-22","endDate":"2020-08-22"}],"totalItemsCount":2,"totalItemsErrors":0,"totalItemsWarnings":0,"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/{customFieldId}/listitems/get-by-ids": { "post": { "tags": [ "CompanyCustomFields" ], "summary": "Get list items defined for a given custom field by IDs", "operationId": "V2CompanyCustomFieldsGetCustomFieldListItemsByIds", "parameters": [ { "name": "customFieldId", "in": "path", "description": "Unique identifier of the custom field", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "IDs of list items to retrieve", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ListItemIds" }, "example": {"ids":["c08084bc-f323-4d84-af55-08d801a11166","99d319f0-c986-4685-b834-08d807e21c71"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/ListItemIds" }, "example": {"ids":["c08084bc-f323-4d84-af55-08d801a11166","99d319f0-c986-4685-b834-08d807e21c71"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/ListItemIds" }, "example": {"ids":["c08084bc-f323-4d84-af55-08d801a11166","99d319f0-c986-4685-b834-08d807e21c71"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListItemIds" }, "example": {"ids":["c08084bc-f323-4d84-af55-08d801a11166","99d319f0-c986-4685-b834-08d807e21c71"]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ListItemSummary" }, "example": {"data":[{"id":"ee1ac863-4404-48c4-b24c-d3c90dc149cb","name":"name_1","externalId":"ext1","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166"},{"id":"7e423074-58b7-4e61-8670-a93e7b704d4e","name":"name_1","externalId":"ext2","status":"Enabled","billingLegalEntityId":"7da7219e-a527-4806-af51-08d801a11166"}],"links":{"next":"/v2/company/customfields/d7708710-cf36-4285-a11c-98603bc96b86/listitems?limit=2&offset=4","count":"/v2/company/customfields/d7708710-cf36-4285-a11c-98603bc96b86/listitems/"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/{customFieldId}/listitems/count": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get count of list items defined for a given custom field", "operationId": "V2CompanyCustomFieldsGetCustomFieldListItemsCount", "parameters": [ { "name": "customFieldId", "in": "path", "description": "Unique identifier of the custom field", "required": true, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filter on list items where name or external ID begins with this string", "schema": { "type": "string" } }, { "name": "searchMode", "in": "query", "description": "Determines whether the search uses prefix matching or exact name or external ID matching", "schema": { "enum": [ "FuzzySearch", "ExternalIdExactSearch", "NameExactSearch" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/listitems/{listItemId}/users/{userId}": { "delete": { "tags": [ "CompanyCustomFields" ], "summary": "Unassign a user from a list item of a custom field", "operationId": "V2CompanyCustomFieldsDeleteListItemUser", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Identifier of a user that you want to unassign from list item", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/listitems/{listItemId}/users/count": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get count of user assignments defined for a given list item", "operationId": "V2CompanyCustomFieldsGetListItemUserAssignmentsCount", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/company/customfields/listitems/{listItemId}/travelapprovers": { "get": { "tags": [ "CompanyCustomFields" ], "summary": "Get a list of travel approvers and travel conflict approvers for a given list item", "operationId": "V2CompanyCustomFieldsGetTravelApprovers", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ListItemTravelApprovers" }, "example": {"data":{"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "CompanyCustomFields" ], "summary": "Update a list of travel approvers and travel conflict approvers for a given list item", "operationId": "V2CompanyCustomFieldsUpdateTravelApprovers", "parameters": [ { "name": "listItemId", "in": "path", "description": "Unique identifier of the list item", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Travel approvers and travel conflict approvers collection", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ListItemTravelApprovers" }, "example": {"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/ListItemTravelApprovers" }, "example": {"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/ListItemTravelApprovers" }, "example": {"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ListItemTravelApprovers" }, "example": {"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ListItemTravelApprovers" }, "example": {"data":{"approvers":["14b3eefc-4011-4a10-989f-dc7572078053","deb8da86-343c-4fe1-b4e6-73879733f393"],"conflictApprovers":["cbc578f0-6a42-4ecc-88e6-89b656b30f9c","bfc182aa-7d1c-48d3-b667-0b4f12362a4f"]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/legal-entities/with-addon/katre": { "get": { "tags": [ "CompanyStructure" ], "summary": "Get legal entity ids with Katre addon enabled", "operationId": "V2CompanyStructureGetLegalEntitiesWithAddon", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_Guid" }, "example": {"data":["22531f03-7854-4eef-9d15-1ba867a9a871","32c1172a-4ab2-485f-b6b2-d3e806e2d7b0"],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/currencies": { "get": { "tags": [ "Currencies" ], "summary": "Get currency of the company", "operationId": "V2CurrenciesGetCompanyCurrencies", "parameters": [ { "name": "branchIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_CompanyCurrencySummary" }, "example": {"data":[{"isoCode":"AUD"},{"isoCode":"PLN"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/customfields": { "get": { "tags": [ "CustomFields" ], "summary": "Get the custom fields", "operationId": "V2CustomFieldsGetCustomFields", "parameters": [ { "name": "limit", "in": "query", "description": "The number of custom fields to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of custom fields to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active custom fields (default is all custom fields)", "schema": { "type": "boolean" } }, { "name": "isFilter", "in": "query", "description": "Indicates custom field where the user can filter on", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the custom fields where the name contain this string", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filter on the custom fields where the custom field type equals", "schema": { "enum": [ "FreeText", "List", "Numeric" ], "type": "string" } }, { "name": "target", "in": "query", "description": "Filter on the custom fields where the custom field target equals", "schema": { "enum": [ "User", "Group", "Expense", "ProjectOfExpense", "TripOfExpense", "CashAdvance" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CustomField" }, "example": {"data":[{"id":"3bfc43ff-6108-43dc-a5a5-f996206a9349","isFilter":false,"name":"test_255","isActive":true,"type":"FreeText"},{"id":"0dfc6195-f874-4978-b8fb-5a0bcdc72c84","isFilter":false,"name":"test_149","isActive":true,"type":"FreeText"}],"links":{"next":"/v2/customfields?limit=2&offset=4&search=t&isActive=true","count":"/v2/customfields/count?search=t&isActive=true"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/customfields/count": { "get": { "tags": [ "CustomFields" ], "summary": "The total count of custom fields", "operationId": "V2CustomFieldsGetCount", "parameters": [ { "name": "isActive", "in": "query", "description": "Filter on active custom fields (default is all custom fields)", "schema": { "type": "boolean" } }, { "name": "isFilter", "in": "query", "description": "Indicates custom field where the user can filter on", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the custom fields where the name contain this string", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Filter on the custom fields where the custom field equals", "schema": { "enum": [ "FreeText", "List", "Numeric" ], "type": "string" } }, { "name": "target", "in": "query", "description": "Filter on the custom fields where the custom field target equals", "schema": { "enum": [ "User", "Group", "Expense", "ProjectOfExpense", "TripOfExpense", "CashAdvance" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/customfields/{customFieldId}": { "get": { "tags": [ "CustomFields" ], "summary": "Get the specific custom field", "operationId": "V2CustomFieldsGetCustomField", "parameters": [ { "name": "customFieldId", "in": "path", "description": "The unique identifier of the custom field", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CustomField" }, "example": {"data":{"id":"c68df547-4001-495d-9fc7-3f3438ed7679","isFilter":false,"name":"test_71","isActive":true,"type":"FreeText"},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/customfields/{customFieldId}/listitems": { "get": { "tags": [ "CustomFields" ], "summary": "Get the custom field's list items", "operationId": "V2CustomFieldsGetCustomFieldListItems", "parameters": [ { "name": "customFieldId", "in": "path", "description": "The requested custom field Id for list items", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of custom field's list items to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of custom field's list items to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active custom field's list items (default is all custom field's list items)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the custom field's list items where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CustomFieldListItem" }, "example": {"data":[{"id":"58a4fe57-393e-463e-8e6d-ae142fef51c8","value":"val_87","code":"code_87","isActive":true},{"id":"47f18e17-7a7a-41d0-9bd6-c037a931b86e","value":"val_23","code":"code_23","isActive":true}],"links":{"next":"/v2/customfields/bd9e0c55-a6b8-46af-b544-d816daf84b0d/listitems?limit=2&offset=4&search=t&isActive=true","count":"/v2/customfields/bd9e0c55-a6b8-46af-b544-d816daf84b0d/listitems/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/customfields/{customFieldId}/listitems/count": { "get": { "tags": [ "CustomFields" ], "summary": "The total count of custom field's list items", "operationId": "V2CustomFieldsGetCustomFieldListItemsCount", "parameters": [ { "name": "customFieldId", "in": "path", "description": "The requested custom field Id for list items", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "isActive", "in": "query", "description": "Filter on active custom field's list items (default is all custom field's list items)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the custom field's list items where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/listitems/{listItemId}": { "get": { "tags": [ "CustomFields" ], "summary": "Get the specific custom field's list item", "operationId": "V2CustomFieldsGetCustomFieldListItem", "parameters": [ { "name": "listItemId", "in": "path", "description": "The unique identifier of the custom field's list item", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CustomFieldListItem" }, "example": {"data":{"id":"19e6066d-b298-4a77-954f-5a96d68776ae","value":"val_109","code":"code_109","isActive":true},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/listitems/fortravel/{customFieldCode}": { "get": { "tags": [ "CustomFields" ], "summary": "Get the custom field's list items for xpd company", "operationId": "V2CustomFieldsGetCustomFieldListItemsOfCompany", "parameters": [ { "name": "customFieldCode", "in": "path", "description": "Filter on the custom field's list items with the code", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "description": "The xpd company Id for list items", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of custom field's list items to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of custom field's list items to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "syncDatetime", "in": "query", "description": "Filter on the custom field's list items with the LastRefreshDate)", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CustomFieldListItem" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/listitems/fortravel/{customFieldCode}/count": { "get": { "tags": [ "CustomFields" ], "summary": "Get the custom field's list items count for xpd company", "operationId": "V2CustomFieldsGetCustomFieldListItemsOfCompanyCount", "parameters": [ { "name": "customFieldCode", "in": "path", "description": "Filter on the custom field's list items with the code", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "query", "description": "The xpd company Id for list items", "schema": { "type": "string", "format": "uuid" } }, { "name": "syncDatetime", "in": "query", "description": "Filter on the custom field's list items with the LastRefreshDate)", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/webhooks": { "post": { "tags": [ "Event" ], "summary": "Allows to register a web hook that needs to be called when an event occurs", "operationId": "V2EventRegisterEvent", "requestBody": { "description": "The information of the web hook to register", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/WebHookChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WebHookChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebHookChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WebHookChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_WebHook" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exchange-rates/sync-branch-exchange-rates": { "post": { "tags": [ "ExchangeRates" ], "summary": "Define custom exchange rates per branch", "operationId": "V2ExchangeRatesSyncBranchExchangeRates", "requestBody": { "description": "The custom exchange rates per branch", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncBranchExchangeRatesRequest" }, "example": {"branchId":"a54928e7-c4c2-4d2f-88d4-1a1b994c1704","startDate":"2026-11-02T00:00:00+01:00","expirationDate":"2026-11-07T00:00:00+01:00","branchExchangeRates":[{"currencyFrom":"EUR","currencyTo":"USD","rate":1.12},{"currencyFrom":"EUR","currencyTo":"CHF","rate":1.18},{"currencyFrom":"GBP","currencyTo":"BRL","rate":7.56954}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncBranchExchangeRatesRequest" }, "example": {"branchId":"a54928e7-c4c2-4d2f-88d4-1a1b994c1704","startDate":"2026-11-02T00:00:00+01:00","expirationDate":"2026-11-07T00:00:00+01:00","branchExchangeRates":[{"currencyFrom":"EUR","currencyTo":"USD","rate":1.12},{"currencyFrom":"EUR","currencyTo":"CHF","rate":1.18},{"currencyFrom":"GBP","currencyTo":"BRL","rate":7.56954}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncBranchExchangeRatesRequest" }, "example": {"branchId":"a54928e7-c4c2-4d2f-88d4-1a1b994c1704","startDate":"2026-11-02T00:00:00+01:00","expirationDate":"2026-11-07T00:00:00+01:00","branchExchangeRates":[{"currencyFrom":"EUR","currencyTo":"USD","rate":1.12},{"currencyFrom":"EUR","currencyTo":"CHF","rate":1.18},{"currencyFrom":"GBP","currencyTo":"BRL","rate":7.56954}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncBranchExchangeRatesRequest" }, "example": {"branchId":"a54928e7-c4c2-4d2f-88d4-1a1b994c1704","startDate":"2026-11-02T00:00:00+01:00","expirationDate":"2026-11-07T00:00:00+01:00","branchExchangeRates":[{"currencyFrom":"EUR","currencyTo":"USD","rate":1.12},{"currencyFrom":"EUR","currencyTo":"CHF","rate":1.18},{"currencyFrom":"GBP","currencyTo":"BRL","rate":7.56954}]} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncBranchExchangeRatesResponse" }, "example": {"creationDate":"2026-11-02T00:00:00+01:00"} } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exchange-rates/get-active-branch-rates": { "get": { "tags": [ "ExchangeRates" ], "summary": "Get active custom exchange rates per branch on a given date", "operationId": "V2ExchangeRatesGetActiveBranchRates", "parameters": [ { "name": "BranchId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "Date", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetActiveBranchRatesResponse" }, "example": {"branchId":"6efafdd6-c7e6-43f3-99f5-d15418ef3330","startDate":"2026-11-02T00:00:00+01:00","expirationDate":"2026-11-07T00:00:00+01:00","branchExchangeRates":[{"currencyFrom":"EUR","currencyTo":"USD","rate":1.12},{"currencyFrom":"EUR","currencyTo":"CHF","rate":1.18},{"currencyFrom":"GBP","currencyTo":"BRL","rate":7.56954}]} } } }, "400": { "description": "Bad Request" }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/reimbursement-jobs/{jobId}": { "get": { "tags": [ "ExpenseReimbursementJobs" ], "summary": "Get a reimbursement job", "description": "Returns the current state of the job, counters for the whole job, and the outcome of every expense in it.\r\nThe counters always describe the whole job, whatever the outcome filter and paging are; totalCount describes\r\nthe filtered expenses before paging.\r\nReading a job requires access to every expense it contains, checked on each call and before any filtering or\r\npaging. If one of those expenses has since been deleted, or falls outside the scope of the caller, the whole\r\njob returns 404, also once the expenses have been reimbursed. Being allowed to reimburse an expense does not\r\nimply being allowed to read it.\r\nAn expense that was already reimbursed before the job ran is reported as SUCCEEDED, without errors.", "operationId": "V2ExpenseReimbursementJobsGetReimbursementJob", "parameters": [ { "name": "jobId", "in": "path", "description": "The UUID of the job, as returned in the Location header when it was submitted.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "Page size, 100 by default and at most 500.", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "Zero-based offset, 0 by default.", "schema": { "type": "integer", "format": "int32", "default": 0 } }, { "name": "outcome", "in": "query", "description": "Optional filter on the outcome of an expense: PENDING, IN_PROGRESS, SUCCEEDED or FAILED.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The job, its counters and the requested page of expense outcomes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReimbursementJobStatusResult" }, "example": {"jobId":"5d1c0f4e-2a3b-4c5d-9e8f-7a6b5c4d3e2f","state":"COMPLETED_WITH_FAILURES","counters":{"total":2,"succeeded":1,"failed":1,"pending":0},"acceptedAt":"2026-10-08T10:00:00+00:00","completedAt":"2026-10-08T10:01:00+00:00","totalCount":2,"data":[{"sequence":0,"expenseId":"0f2a4c1e-7b7d-4f3a-9a52-3a1c6d9e8b10","outcome":"SUCCEEDED","errors":[],"completedAt":"2026-10-08T10:00:10+00:00"},{"sequence":1,"expenseId":"8c1b2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e","outcome":"FAILED","errors":["EXPENSE_NOT_REIMBURSABLE"],"completedAt":"2026-10-08T10:00:20+00:00"}],"links":{}} } } }, "400": { "description": "The paging or the outcome filter is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobErrorResult" }, "example": {"errors":[{"code":"INVALID_EXPENSE_ID","message":"The expense id is missing or is not a valid UUID.","index":1}]} } } }, "404": { "description": "The job does not exist, or it contains an expense that cannot be read" }, "500": { "description": "Server Error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/reimbursement-jobs": { "post": { "tags": [ "ExpenseReimbursementJobs" ], "summary": "Submit a bulk reimbursement job", "description": "The job is accepted straight away and the expenses are reimbursed afterwards, so a 202 confirms that the request\r\nwas accepted, not that every expense was reimbursed. Follow the job with the URL returned in the Location header:\r\neach expense is handled on its own and its outcome is reported there.\r\nA 400 means that no job was created, and is returned only when the request itself cannot be read, for example an\r\nempty or oversized list of expenses, or a malformed UUID. Expenses that do not exist, that are locked, or that\r\ncannot be reimbursed are reported per expense in the job once it has run.\r\nSend an Idempotency-Key header to retry a submission safely: repeating it with the same key and the same body\r\nreturns the job that was already created instead of creating a second one, while the same key with a different\r\nbody is refused with 409. Without a key, every submission creates a new job.\r\nReading a job requires access to every expense it contains. An expense that may be reimbursed but not read, for\r\nexample one belonging to a branch outside the scope of the caller, makes the job return 404, including when a\r\nsubmission is replayed with its idempotency key.\r\nA ReimbursementJobCompleted webhook can be enabled for the company to signal that a job has finished; ask your\r\ntechnical contact person to set it up. It carries the identity of the job and its final counters, not the outcome\r\nof each expense, and the same notification can be delivered more than once. Treat the job itself as the source of\r\ntruth: read it for the outcome per expense, and ignore a notification whose event id was already handled.", "operationId": "V2ExpenseReimbursementJobsCreateReimbursementJob", "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "Optional key (1 to 255 printable ASCII characters) to safely retry the submission", "schema": { "type": "string" } } ], "requestBody": { "description": "The expenses to reimburse", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CreateReimbursementJobData" }, "example": {"expenses":[{"expenseId":"0f2a4c1e-7b7d-4f3a-9a52-3a1c6d9e8b10","paymentReference":"PAY-001"},{"expenseId":"8c1b2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e","paymentReference":null}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateReimbursementJobData" }, "example": {"expenses":[{"expenseId":"0f2a4c1e-7b7d-4f3a-9a52-3a1c6d9e8b10","paymentReference":"PAY-001"},{"expenseId":"8c1b2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e","paymentReference":null}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateReimbursementJobData" }, "example": {"expenses":[{"expenseId":"0f2a4c1e-7b7d-4f3a-9a52-3a1c6d9e8b10","paymentReference":"PAY-001"},{"expenseId":"8c1b2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e","paymentReference":null}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateReimbursementJobData" }, "example": {"expenses":[{"expenseId":"0f2a4c1e-7b7d-4f3a-9a52-3a1c6d9e8b10","paymentReference":"PAY-001"},{"expenseId":"8c1b2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e","paymentReference":null}]} } } }, "responses": { "202": { "description": "The job was accepted, or an identical submission was replayed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReimbursementJobResult" }, "example": {"jobId":"5d1c0f4e-2a3b-4c5d-9e8f-7a6b5c4d3e2f","state":"ACCEPTED","acceptedAt":"2026-09-16T10:00:00+00:00"} } } }, "400": { "description": "The request is invalid; no job was created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobErrorResult" }, "example": {"errors":[{"code":"INVALID_EXPENSE_ID","message":"The expense id is missing or is not a valid UUID.","index":1}]} } } }, "404": { "description": "The idempotency key matches a job that contains an expense the caller cannot read" }, "409": { "description": "The idempotency key was already used with a different request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobErrorResult" }, "example": {"errors":[{"code":"INVALID_EXPENSE_ID","message":"The expense id is missing or is not a valid UUID.","index":1}]} } } }, "429": { "description": "The company already has the maximum number of jobs in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobErrorResult" }, "example": {"errors":[{"code":"INVALID_EXPENSE_ID","message":"The expense id is missing or is not a valid UUID.","index":1}]} } } }, "503": { "description": "The acceptance could not be confirmed; retry with the same idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkJobErrorResult" }, "example": {"errors":[{"code":"INVALID_EXPENSE_ID","message":"The expense id is missing or is not a valid UUID.","index":1}]} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/reject": { "post": { "tags": [ "Expenses" ], "summary": "Reject a set of expenses", "operationId": "V2ExpensesRejectExpenses", "requestBody": { "description": "The target status and the expenses to change", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RejectExpensesData" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RejectExpensesData" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectExpensesData" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectExpensesData" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ChangeExpenseStatusResults" }, "example": {"data":{"results":[{"expenseId":"fac20ca9-990d-4b8a-97a0-3851b02d6df0","errorCode":14001}]},"messages":[{"code":0,"message":"Expense statuses successfully changed."}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/changestatus": { "post": { "tags": [ "Expenses" ], "summary": "Change the status of a set of expenses to a specific status", "operationId": "V2ExpensesChangeStatusForExpenses", "requestBody": { "description": "The target status and the expenses to change", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeExpenseStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeExpenseStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeExpenseStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeExpenseStatus" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ChangeExpenseStatusResults" }, "example": {"data":{"results":[{"expenseId":"b9531684-2512-4ad1-9e13-5a6bef7fa8fe","errorCode":14001}]},"messages":[{"code":0,"message":"Expense statuses successfully changed."}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/tobereported": { "get": { "tags": [ "Expenses" ], "summary": "The expenses to be reported", "operationId": "V2ExpensesGetExpensesToBeReported", "parameters": [ { "name": "limit", "in": "query", "description": "The number of expenses to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of expenses to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ExpenseToBeReported" }, "example": {"data":[{"id":"9a4f9472-ea2a-4f2c-8ea3-12d48bba8de8","xpdReference":"XPD114","branch":{"id":"d090f63c-7a35-4354-8292-d8b53dac4515","refId":"ref_d090f63c-7a35-4354-8292-d8b53dac4515","name":"name_d090f63c-7a35-4354-8292-d8b53dac4515"},"group":{"id":"88dd7d5b-50ec-48fb-80a2-1b0da4266639","refId":"ref_88dd7d5b-50ec-48fb-80a2-1b0da4266639","name":"name_88dd7d5b-50ec-48fb-80a2-1b0da4266639"},"user":{"id":"54bed21d-f2cf-4ec9-9242-cfbbd4468b68","refId":"ref_54bed21d-f2cf-4ec9-9242-cfbbd4468b68","name":"name_54bed21d-f2cf-4ec9-9242-cfbbd4468b68"},"originalAmount":223.0,"originalCurrency":"GBP","tax":null,"convertedCurrencies":[{"amount":3.0,"currency":"DKK","taxAmount":2.0,"exchangeRate":1.0}],"isInvoice":false,"invoiceNumber":null,"mileage":null,"comment":null,"merchant":{"id":"a8a73b6f-53db-42da-bee9-105d3bb1183d","name":"name_a8a73b6f-53db-42da-bee9-105d3bb1183d"},"country":"GBR","project":{"id":"b314076f-34df-4d2d-bbde-4700b84432fe","refId":"ref_b314076f-34df-4d2d-bbde-4700b84432fe","name":"name_b314076f-34df-4d2d-bbde-4700b84432fe"},"isReimbursable":false,"transactions":null,"status":"Reported","date":"2026-11-02T14:19:47.1785451+01:00","dateApproved":"2026-11-02T15:19:47.1785489+01:00","dateControlled":null,"imageUrl":null,"category":{"id":"38f4b8c8-a4cc-44bd-9f5a-b2ffc32fb581","number":"200","additionalNumber":null,"name":"name_38f4b8c8-a4cc-44bd-9f5a-b2ffc32fb581"},"customFields":null,"advance":null,"paymentMethod":{"id":"d2971881-cc65-4c0f-86d1-ba1db5ce73e2","type":"Cash","accountNumber":"151","name":"name_d2971881-cc65-4c0f-86d1-ba1db5ce73e2","cardNumber":"151","ownership":"Company"},"expenseType":"Expense"},{"id":"def7e1a0-8d67-4288-9730-fecec4994aed","xpdReference":"XPD160","branch":{"id":"88815ac4-7c28-4a77-b482-214a6d7250fc","refId":"ref_88815ac4-7c28-4a77-b482-214a6d7250fc","name":"name_88815ac4-7c28-4a77-b482-214a6d7250fc"},"group":{"id":"6c19d687-2512-4f3d-a46c-4a0c6c138d39","refId":"ref_6c19d687-2512-4f3d-a46c-4a0c6c138d39","name":"name_6c19d687-2512-4f3d-a46c-4a0c6c138d39"},"user":{"id":"be3fc1a1-a668-4d35-9ce1-4e10b22b92f2","refId":"ref_be3fc1a1-a668-4d35-9ce1-4e10b22b92f2","name":"name_be3fc1a1-a668-4d35-9ce1-4e10b22b92f2"},"originalAmount":223.0,"originalCurrency":"GBP","tax":null,"convertedCurrencies":[{"amount":3.0,"currency":"DKK","taxAmount":2.0,"exchangeRate":1.0}],"isInvoice":false,"invoiceNumber":null,"mileage":null,"comment":null,"merchant":{"id":"d773a898-3f0d-4f3b-a090-4377ea417f4a","name":"name_d773a898-3f0d-4f3b-a090-4377ea417f4a"},"country":"GBR","project":{"id":"61580bd4-3a9d-4034-bea5-5181559d17fd","refId":"ref_61580bd4-3a9d-4034-bea5-5181559d17fd","name":"name_61580bd4-3a9d-4034-bea5-5181559d17fd"},"isReimbursable":false,"transactions":null,"status":"Reported","date":"2026-11-02T14:19:47.1785619+01:00","dateApproved":"2026-11-02T15:19:47.1785625+01:00","dateControlled":null,"imageUrl":null,"category":{"id":"ab52bdd8-8c96-4926-b08e-dfc670077b93","number":"216","additionalNumber":null,"name":"name_ab52bdd8-8c96-4926-b08e-dfc670077b93"},"customFields":null,"advance":null,"paymentMethod":{"id":"66e0f914-3748-4359-8a77-adb99cf1c377","type":"Cash","accountNumber":"224","name":"name_66e0f914-3748-4359-8a77-adb99cf1c377","cardNumber":"224","ownership":"Company"},"expenseType":"Expense"}],"links":{"next":"/v2/expenses/tobereported?limit=1&offset=2","count":"/v2/expenses/tobereported/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/exported": { "get": { "tags": [ "Expenses" ], "summary": "Exported expenses", "operationId": "V2ExpensesGetExportedExpenses", "parameters": [ { "name": "exportedAtStartDate", "in": "query", "description": "Beginning of time range for filtering expenses by export date", "schema": { "type": "string" } }, { "name": "exportedAtEndDate", "in": "query", "description": "End of time range for filtering expenses by export date", "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "Filter to only retrieve the expenses for 1 specific branch", "schema": { "type": "string" } }, { "name": "tripId", "in": "query", "description": "Filter to only retrieve the expenses of 1 specific trip", "schema": { "type": "string" } }, { "name": "onlyLatestVersions", "in": "query", "description": "Get only latest versions of expenses", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Filter to only retrieve the expenses of 1 specific user", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter to only retrieve the expenses for 1 specific group", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of expenses to return", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "The number of expenses to skip (used for paging)", "schema": { "type": "string" } }, { "name": "includeMultipleVatParent", "in": "query", "description": "Whether to include parent expenses of multiple VAT rates", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResultCounted_Of_Object" }, "example": {"totalCount":3,"data":[{"exportedAt":"2021-01-22T13:45:09Z","expenseId":"e5b1dec2-afec-4201-8c93-09ffa479418c","refId":"XPD012216312","type":"RegularExpense","amount":1120.0,"netAmount":1000.0,"currency":"EUR","expenseDate":"2021-01-02","merchant":"Four Seasons","merchantEnterpriseNumber":"58325","comment":null,"expenseStatus":"Approved","isReimbursable":false,"image":{"url":"https://streaming.rydoo.com/Receipt/original/9c843341-af19-4003-84bb-a1d29197beaa/9c843341-af19-4003-84bb-a1d29197beaa/1b43875e-633e-43ac-8a1c-ad1fd023c490","base64String":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABgQEBAUEB...H/9k=","fileExtension":"JPEG"},"attachments":[{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/e8704947-9d56-462b-ae4a-7c1a5a2ff7da/download/false/Expense?d=24032021121727"},{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/f7f5fd35-5fd0-4b28-adc2-d518fadc0fbc/download/false/Expense?d=21122021121616"}],"attendees":[{"id":"eeb86106-57a2-4c2e-8dc5-0e3e704eb880","fullName":"Amalia Claupfer","email":"amelia@aurora.com","type":"Guest"},{"id":"67e2d9b4-6be1-44e9-a38d-469f96b6a2b3","fullName":"Sandra Malcory","email":"sandra.malcory@aurora.com","type":"User"}],"branch":{"branchId":"1f0ee19a-b40d-e711-81fc-005156bf1aff","refId":"110","name":"ACMECorp Canada","enterpriseNumber":"110","currency":"CAD","amount":1756.51,"netAmount":1568.31,"taxAmount":188.2},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"77738a64-a25d-438f-98d5-5431ee47d84b","refId":"123456","firstName":"Kate","lastName":"Friedman","email":"kate.friedman@acmecorp.com","iban":"BE123145678901"},"category":{"categoryId":"b5a46e5c-1886-4177-81c3-2ce1114be869","name":"Hotels (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[{"customFieldId":"3c0f8d45-bbd1-4c16-89c8-75cf8d9d7ea9","name":"Office location","isRequired":true,"isEnabled":true,"value":"Toronto","code":"490"}],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":null,"invoice":{"isInvoice":true,"invoiceNumber":"PL68392"},"meansOfPayment":{"paymentMethodId":"fe5hc4b3-9767-4ebf-1084-2ebba4771ede","paymentMethod":"CreditCard","name":"CompanyCreditCard","cardOwnership":"CompanyCard","cardNumber":"5032","accountNumber":"0532013000","travellerId":null,"matchStatus":"Confirmed","transactions":[{"processorTransactionId":"111-9000474744547474","mcFinancialTransactionId":"0446576452083664145840","acquirerReferenceNumber":"5920486820"}]},"calculatedCurrencies":[{"amount":1312.68,"netAmount":1172.04,"currency":"USD","taxAmount":140.64},{"amount":28809.4,"netAmount":25722.68,"currency":"MXN","taxAmount":3086.72}],"taxRate":{"taxAmount":120.0,"taxRate":12.0,"taxCode":"CAN Purchases 12%","subRates":[{"amount":50.0,"rate":5.0,"name":"GST"},{"amount":70.0,"rate":7.0,"name":"PST"}]},"hotel":{"checkIn":"2021-01-01T10:00:00","checkOut":"2021-01-02T10:00:00","numberOfNights":1},"location":{"countryCode":"CA","country":"Canada","region":"Ontario","city":"Toronto"},"linkTravel":null,"perDiem":null,"mileage":null,"history":{"submittedAt":"2021-01-02T10:00:00","approvedAt":"2021-01-04T11:06:12.793","approvedBy":"approver@acmecorp.com","controlledAt":null,"controlledBy":null},"rejectReasons":[{"title":"Duplicated expense","type":"Duplicate"}],"countrySpecific":null,"parentExpenseId":"ac20133e-ddc7-44a9-b78c-ef7247ce8405","hasChildren":false},{"exportedAt":"2021-01-03T15:23:03Z","expenseId":"9e237a2c-0580-4c9e-9b87-7ff2a070ab84","refId":"XPD012216312","type":"Mileage","amount":82.75,"netAmount":78.0,"currency":"MXN","expenseDate":"2021-01-06","merchant":null,"merchantEnterpriseNumber":null,"comment":null,"expenseStatus":"Controlled","isReimbursable":true,"image":null,"attachments":[{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/e8704947-9d56-462b-ae4a-7c1a5a2ff7da/download/false/Expense?d=24032021121727"},{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/f7f5fd35-5fd0-4b28-adc2-d518fadc0fbc/download/false/Expense?d=21122021121616"}],"branch":{"branchId":"5c5d9e27-b33b-4bfb-b585-1cbcda0f1443","refId":"113","name":"ACMECorp Mexico","enterpriseNumber":"113","currency":"MXN","amount":82.75,"netAmount":78.0,"taxAmount":4.75},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"10b2bd0f-723b-44e9-a392-f35462827fbc","refId":"654321","firstName":"John","lastName":"Smith","email":"john.smith@acmecorp.com","iban":"BE123145671457"},"category":{"categoryId":"046fbf87-4d67-4db0-84ab-cd66f835611f","name":"Mileage (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":null,"invoice":{"isInvoice":false,"invoiceNumber":null},"meansOfPayment":{"paymentMethodId":"b1ef1bdd-5e6a-4679-a4b9-eca5e26cede7","paymentMethod":"Cash","name":"Cash","cardOwnership":"Personal","cardNumber":null,"accountNumber":"0532013000","travellerId":null,"matchStatus":"None","transactions":[]},"calculatedCurrencies":[],"taxRate":{"taxAmount":4.75,"taxRate":6.0906,"taxCode":"MXN Mileage","subRates":[]},"hotel":null,"location":{"countryCode":"MX","country":"Mexico","region":"Mexico","city":"Mexico City"},"linkTravel":null,"perDiem":null,"mileage":{"mileageRateName":"Own car (domestic and abroad) 2,50 MXN/km","from":"Mexico City, Mexico","to":"Toxcuca, Mexico","distance":33.1,"isBackAndForth":false,"distanceUnit":"km","mileageRates":{"mainRate":{"rate":2.5,"code":"135-0000296","distance":33.1},"subRates":[{"rate":1.4252,"code":"S20","distance":10.0},{"rate":3.0,"code":"S30","distance":270.0}]}},"history":{"submittedAt":"2021-01-07T12:00:00","approvedAt":"2021-01-07T17:21:56.128","approvedBy":"approver@acmecorp.com","controlledAt":"2021-01-08T17:21:56.128","controlledBy":"controller@acmecorp.com"},"rejectReasons":[],"countrySpecific":{"mexico":{"validationStatus":"Valid","cfdiGuid":"318b0fe6-235f-499d-adbb-e517b24c6ckd","rfcNumber":"RCS070607MF9","invalidReason":null}},"parentExpenseId":null,"hasChildren":false},{"exportedAt":"2021-01-03T15:23:03Z","expenseId":"020c3bd9-1aac-42ac-973a-6ebbfab7bef4","refId":"XPD012216312","type":"PerDiem","amount":55.0,"netAmount":52.04,"currency":"NOK","expenseDate":"2021-01-03","merchant":null,"merchantEnterpriseNumber":null,"comment":"Business trip","expenseStatus":"Controlled","isReimbursable":true,"image":null,"attachments":[],"branch":{"branchId":"1f0ee19a-b40d-e711-81fc-005156bf1aff","refId":"111","name":"ACMECorp Norway","enterpriseNumber":"111","currency":"NOK","amount":55.0,"netAmount":52.04,"taxAmount":2.96},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"10b2bd0f-723b-44e9-a392-f35462827fbc","refId":"654321","firstName":"John","lastName":"Smith","email":"john.smith@acmecorp.com","iban":"BE123145671457"},"category":{"categoryId":"9e1f22f5-b96f-47de-9bcf-cc2cb54d6477","name":"Per Diem (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":{"tripId":"1e99a49a-1091-4c7f-55fa-61503f5bd560","refId":"TRP013156185","name":"Oslo trip","startDate":"2021-01-02T20:00:00","endDate":"2021-01-03T12:00:00"},"invoice":{"isInvoice":false,"invoiceNumber":null},"meansOfPayment":{"paymentMethodId":"b1ef1bdd-5e6a-4679-a4b9-eca5e26cede7","paymentMethod":"Cash","name":"Cash","cardOwnership":"Personal","cardNumber":null,"accountNumber":"0532013000","travellerId":null,"matchStatus":"None","transactions":[]},"calculatedCurrencies":[],"taxRate":{"taxAmount":2.96,"taxRate":5.69,"taxCode":"NOK Per Diem","subRates":[]},"hotel":null,"location":{"countryCode":"NO","country":"Norway","region":"Norway","city":"Oslo"},"linkTravel":{"linkId":"605320","linkCode":"8LOJSF","bookingId":"2121324"},"perDiem":{"rate":{"amount":55.0,"name":"Allowance with overnight stay","code":"111-0000111"},"duration":"16:00","region":"Norway","currency":"NOK","deductions":[{"name":"Lunch","code":"222-0000222","amount":8.2}],"supplements":[{"name":"Overnight","code":"OVE","amount":30.0}]},"mileage":null,"history":{"submittedAt":"2021-01-03T12:00:00","approvedAt":"2021-01-05T17:21:56.128","approvedBy":"approver@acmecorp.com","controlledAt":"2021-01-06T17:21:56.128","controlledBy":"controller@acmecorp.com"},"rejectReasons":[],"countrySpecific":null,"parentExpenseId":null,"hasChildren":false}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses": { "get": { "tags": [ "Expenses" ], "summary": "Get expenses", "operationId": "V2ExpensesGetExpenses", "parameters": [ { "name": "Limit", "in": "query", "description": "The number of expenses to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "The number of expenses to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "UserId", "in": "query", "description": "Expense User unique identifier", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExpenseStatus", "in": "query", "description": "Expense status", "schema": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string" } }, { "name": "PaymentMethodId", "in": "query", "description": "Expense payment method id", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExpenseStatement", "in": "query", "description": "Expense statement", "schema": { "enum": [ "Default", "None", "MatchFound", "Confirmed" ], "type": "string" } }, { "name": "ExpenseType", "in": "query", "description": "Expense type", "schema": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" } }, { "name": "IsReimbursable", "in": "query", "description": "Filer on reimbursable expenses", "schema": { "type": "boolean" } }, { "name": "IsInvoice", "in": "query", "description": "Filter on expeses which are invoices", "schema": { "type": "boolean" } }, { "name": "ProjectId", "in": "query", "description": "Id of the project which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "TripId", "in": "query", "description": "Id of the trip which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "GroupId", "in": "query", "description": "Id of the department which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "RuleId", "in": "query", "description": "Id of the rule which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "VatAmount", "in": "query", "description": "VAT amount", "schema": { "type": "number", "format": "double" } }, { "name": "VatPercentage", "in": "query", "description": "VAT percentage", "schema": { "type": "number", "format": "double" } }, { "name": "TaxableAmount", "in": "query", "description": "Taxable amount", "schema": { "type": "number", "format": "double" } }, { "name": "TaxRateId", "in": "query", "description": "Id of the tax rate which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "EnterpriseNumberMerchant", "in": "query", "description": "Merchant number", "schema": { "type": "string" } }, { "name": "ExcludeReported", "in": "query", "description": "Exclude expenses that are reported", "schema": { "type": "boolean" } }, { "name": "StartDate", "in": "query", "description": "Start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "End date", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateSubmitted", "in": "query", "description": "The start of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateSubmitted", "in": "query", "description": "The end of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateReported", "in": "query", "description": "The start of the date range when expence has been reported", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateReported", "in": "query", "description": "The end of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateCompleted", "in": "query", "description": "The start of the date range when expence has been completed", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateCompleted", "in": "query", "description": "The end of the date range when expence has been completed", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateApproved", "in": "query", "description": "The start of the date range when expence has been approved", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateApproved", "in": "query", "description": "The end of the date range when expence has been approved", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateReimbursed", "in": "query", "description": "The start of the date range when expense has been reimbursed", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateReimbursed", "in": "query", "description": "The end of the date range when expense has been reimbursed", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateControlled", "in": "query", "description": "The start of the date range when expence has been controlled", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateControlled", "in": "query", "description": "The end of the date range when expence has been controlled", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateAdded", "in": "query", "description": "The start of the date range expence has been added", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateAdded", "in": "query", "description": "The end of the date range when expence has been added", "schema": { "type": "string", "format": "date-time" } }, { "name": "CategoryId", "in": "query", "description": "Id of the category which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "BranchId", "in": "query", "description": "Id of the branch which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "CustomFieldListItemId", "in": "query", "description": "Id of the custom field list item which is related to Expense", "schema": { "type": "string" } }, { "name": "HasRuleViolations", "in": "query", "description": "Filter on expeses which are has rule violations", "schema": { "type": "boolean" } }, { "name": "IsTodo", "in": "query", "description": "Filter on expenses which are located in Todo list", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ExpenseSummary" }, "example": {"data":[{"id":"49737ad7-38a7-4666-8016-349c6a48c743","date":"2026-11-02T14:19:47.2194534+01:00","merchantName":"merch_49737ad7-38a7-4666-8016-349c6a48c743","userFullName":"user_49737ad7-38a7-4666-8016-349c6a48c743","originalAmount":200.0,"originalCurrency":"EUR","convertedCurrencies":null,"expenseType":"Expense","status":"Submitted","mileage":null,"perdiem":null,"matchStatus":"Default","isDateModified":false,"isAmountModified":false,"isCurrencyModified":false,"isExchangeRateModified":false,"hasRuleViolations":false,"hasPotentialDuplicate":false,"hasRejectHistory":false,"softSplitType":null,"parentExpenseGuid":null,"softSplitChildrenIds":null},{"id":"9c5e1155-bad9-4246-a533-f6efa0f062b2","date":"2026-11-02T14:19:47.2194601+01:00","merchantName":"merch_a1b6efb8-9014-43e3-9a19-e36d124a9059","userFullName":"user_a1b6efb8-9014-43e3-9a19-e36d124a9059","originalAmount":200.0,"originalCurrency":"EUR","convertedCurrencies":null,"expenseType":"Expense","status":"Submitted","mileage":null,"perdiem":null,"matchStatus":"Default","isDateModified":false,"isAmountModified":false,"isCurrencyModified":false,"isExchangeRateModified":false,"hasRuleViolations":false,"hasPotentialDuplicate":false,"hasRejectHistory":false,"softSplitType":"Parent","parentExpenseGuid":null,"softSplitChildrenIds":["fb02541f-83b6-4d79-b635-b8f6bd52aa2d","434bafcd-60f3-4333-942a-2803e4e6223e"]},{"id":"fb02541f-83b6-4d79-b635-b8f6bd52aa2d","date":"2026-11-02T14:19:47.2194628+01:00","merchantName":"merch_a243e176-7a80-436a-bfe5-6a10dd9e1997","userFullName":"user_a243e176-7a80-436a-bfe5-6a10dd9e1997","originalAmount":200.0,"originalCurrency":"EUR","convertedCurrencies":null,"expenseType":"Expense","status":"Submitted","mileage":null,"perdiem":null,"matchStatus":"Default","isDateModified":false,"isAmountModified":false,"isCurrencyModified":false,"isExchangeRateModified":false,"hasRuleViolations":false,"hasPotentialDuplicate":false,"hasRejectHistory":false,"softSplitType":"Child","parentExpenseGuid":"9c5e1155-bad9-4246-a533-f6efa0f062b2","softSplitChildrenIds":null}],"links":{"next":"/v2/expenses?limit=1&offset=2&ExpenseStatus=Submitted&ExpenseType=Expense","count":"/v2/expenses/count?ExpenseStatus=Submitted&ExpenseType=Expense"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/{expenseId}/approvers": { "get": { "tags": [ "Expenses" ], "summary": "Get the possible approvers and controllers of an expense", "operationId": "V2ExpensesGetPossibleApprovers", "parameters": [ { "name": "expenseId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PossibleApproversOfExpense" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/count": { "get": { "tags": [ "Expenses" ], "summary": "Get expenses count", "operationId": "V2ExpensesGetExpensesCount", "parameters": [ { "name": "UserId", "in": "query", "description": "Expense User unique identifier", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExpenseStatus", "in": "query", "description": "Expense status", "schema": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string" } }, { "name": "PaymentMethodId", "in": "query", "description": "Expense payment method id", "schema": { "type": "string", "format": "uuid" } }, { "name": "ExpenseStatement", "in": "query", "description": "Expense statement", "schema": { "enum": [ "Default", "None", "MatchFound", "Confirmed" ], "type": "string" } }, { "name": "ExpenseType", "in": "query", "description": "Expense type", "schema": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" } }, { "name": "IsReimbursable", "in": "query", "description": "Filer on reimbursable expenses", "schema": { "type": "boolean" } }, { "name": "IsInvoice", "in": "query", "description": "Filter on expeses which are invoices", "schema": { "type": "boolean" } }, { "name": "ProjectId", "in": "query", "description": "Id of the project which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "TripId", "in": "query", "description": "Id of the trip which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "GroupId", "in": "query", "description": "Id of the department which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "RuleId", "in": "query", "description": "Id of the rule which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "VatAmount", "in": "query", "description": "VAT amount", "schema": { "type": "number", "format": "double" } }, { "name": "VatPercentage", "in": "query", "description": "VAT percentage", "schema": { "type": "number", "format": "double" } }, { "name": "TaxableAmount", "in": "query", "description": "Taxable amount", "schema": { "type": "number", "format": "double" } }, { "name": "TaxRateId", "in": "query", "description": "Id of the tax rate which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "EnterpriseNumberMerchant", "in": "query", "description": "Merchant number", "schema": { "type": "string" } }, { "name": "ExcludeReported", "in": "query", "description": "Exclude expenses that are reported", "schema": { "type": "boolean" } }, { "name": "StartDate", "in": "query", "description": "Start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDate", "in": "query", "description": "End date", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateSubmitted", "in": "query", "description": "The start of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateSubmitted", "in": "query", "description": "The end of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateReported", "in": "query", "description": "The start of the date range when expence has been reported", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateReported", "in": "query", "description": "The end of the date range when expence has been submitted", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateCompleted", "in": "query", "description": "The start of the date range when expence has been completed", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateCompleted", "in": "query", "description": "The end of the date range when expence has been completed", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateApproved", "in": "query", "description": "The start of the date range when expence has been approved", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateApproved", "in": "query", "description": "The end of the date range when expence has been approved", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateReimbursed", "in": "query", "description": "The start of the date range when expense has been reimbursed", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateReimbursed", "in": "query", "description": "The end of the date range when expense has been reimbursed", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateControlled", "in": "query", "description": "The start of the date range when expence has been controlled", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateControlled", "in": "query", "description": "The end of the date range when expence has been controlled", "schema": { "type": "string", "format": "date-time" } }, { "name": "StartDateAdded", "in": "query", "description": "The start of the date range expence has been added", "schema": { "type": "string", "format": "date-time" } }, { "name": "EndDateAdded", "in": "query", "description": "The end of the date range when expence has been added", "schema": { "type": "string", "format": "date-time" } }, { "name": "CategoryId", "in": "query", "description": "Id of the category which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "BranchId", "in": "query", "description": "Id of the branch which is related to Expense", "schema": { "type": "string", "format": "uuid" } }, { "name": "CustomFieldListItemId", "in": "query", "description": "Id of the custom field list item which is related to Expense", "schema": { "type": "string" } }, { "name": "HasRuleViolations", "in": "query", "description": "Filter on expeses which are has rule violations", "schema": { "type": "boolean" } }, { "name": "IsTodo", "in": "query", "description": "Filter on expenses which are located in Todo list", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/{expenseId}": { "get": { "tags": [ "Expenses" ], "summary": "Get an expense by ID", "operationId": "V2ExpensesGetExpenseById", "parameters": [ { "name": "expenseId", "in": "path", "description": "The expense's unique identifier", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Expense" }, "example": {"data":{"id":"a9f0e27d-18b8-4feb-8854-577cbb29417f","xpdReference":"XPD125","status":"Reported","dateApproved":"2026-11-02T15:19:47.2862116+01:00","dateControlled":null,"group":{"id":"0248e44d-c566-45c3-9b06-31484f681e94","name":"gr_77","refId":"grref_77"},"user":{"id":"165e0430-bb29-4735-be37-3be1bd16f495","refId":"ref_48","name":"user_48@mail.com"},"originalAmount":223.0,"originalCurrency":"GBP","convertedCurrencies":null,"tax":null,"isInvoice":false,"invoiceNumber":null,"comment":null,"merchant":{"id":"f785bddb-316a-48a4-b082-fb4ae8d43e7c","name":"name_f785bddb-316a-48a4-b082-fb4ae8d43e7c"},"country":"GBR","project":{"id":"ff73c7f7-0f81-464f-a9fc-01cded1a2b2c","name":"test_247","refId":"ref_247"},"isReimbursable":false,"date":"2026-11-02T14:19:47.2862096+01:00","category":{"id":"355ef006-6b13-4537-b031-8f2d41475a39","name":"categ_6","refId":"ref_6"},"customFields":null,"advance":{"id":"f4e0dedc-ab4a-4133-8a9d-5c0be5ed9df5","name":"adv_220"},"paymentMethod":{"id":"b6ae848c-0002-4a33-89c4-08b3c275cf98","name":"payment_b6ae848c-0002-4a33-89c4-08b3c275cf98"},"expenseType":"Expense","trip":null,"mileage":null,"violatedRules":null,"attachments":null,"link":null},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/expense": { "post": { "tags": [ "Expenses" ], "operationId": "V2ExpensesAddRegularExpense", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RegularExpenseChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RegularExpenseChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RegularExpenseChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RegularExpenseChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Expense" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/expenses/reimburse": { "put": { "tags": [ "Expenses" ], "summary": "Set expenses status to Reimbursed", "operationId": "V2ExpensesReimburseExpense", "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReimburseExpenseData" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReimburseExpenseData" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReimburseExpenseData" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReimburseExpenseData" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ReimburseExpenseResult" }, "example": {"data":[{"expenseId":"3a1e8126-5ba5-4fe5-8582-9e3a4dad2055","xpdReference":"XPD000000001","expenseStatus":"Reimbursed","errorCode":null,"message":"Successfully set to reimbursed"},{"expenseId":"6edeb21d-df4d-4d5d-87dc-5f0007ab542c","xpdReference":"XPD000000002","expenseStatus":"Reported","errorCode":5079,"message":"Expense was not set as reimbursable so could not be set to reimbursed"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}": { "get": { "tags": [ "Expenses" ], "summary": "Get an expense by UUID", "operationId": "V3ExpensesGetExpenseById", "parameters": [ { "name": "id", "in": "path", "description": "The expense's UUID", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Currencies", "in": "query", "description": "List of currency codes for which to provide converted expense amount.\r\nCan request maximum 3.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "IncludeBranchCurrency", "in": "query", "description": "When true, currencies parameter is ignored and only exchange rate for branch currency is returned.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Returns the expense matching the request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExpenseByIdResponse" }, "example": {"id":"0b7f7491-de62-46e6-8bb4-f840f087cb2c","user":{"id":"d71c4497-58ae-42b4-af13-7c40e098c54a","firstName":"Karl","lastName":"Schwarz","email":"karl.swcharz@digital-corp.com","externalId":"USR003"},"xpdReference":"XPD071740127","parentXpdReference":null,"parentExpenseGuid":null,"expenseDate":"2022-10-01T00:00:00+00:00","expenseType":"Regular","expenseStatus":"Submitted","comment":"Had lunch with @Polly Ester and @Ivana Tinkle","amount":489.98,"currencyCode":"EUR","group":{"id":"fe7d646f-0c1f-49b5-803e-79f4480df21b","name":"Marketing","branchId":"00000000-0000-0000-0000-000000000000","groupId":null},"branch":{"id":"19604afe-fb7d-45c0-8f90-c44cbfc6ba6f","name":"Belgium","countryCode":"BEL"},"category":{"id":"34c543f4-4888-42d5-bd3b-9625385156ed","name":"Lunch","accountingCode":"some code"},"project":{"id":"a8d64af1-26a8-481d-b0d1-abda987a0824","name":"Pilot for customer","projectId":null},"countryCode":"BEL","location":{"id":"a9b5f240-7a06-41c9-a843-0d4aa1de7472","city":"Mechelen","region":"Flanders","country":"Belgium"},"trip":{"id":"23c1a2a1-368f-4a9b-9ab9-c6f3f9024969","name":"Trip from Germany to Belgium","tripId":"TRP002317660"},"receipt":{"id":"4ba46f6e-9480-4355-9c78-11e08fbbe923","totalPages":1},"regular":{"taxPercentage":21.0,"taxAmount":52.50,"netAmount":null,"matchStatus":"NoMatch","checkInDate":"2022-09-28T00:00:00+00:00","checkOutDate":"2022-10-03T00:00:00+00:00","paymentMethod":{"id":"4f1468b6-27eb-4b38-b971-cebbe2d294cd","name":"Cash","type":"Cash","ownership":"Personal"},"advance":null,"taxRate":{"id":"fd1a8d45-a10e-4811-acc3-529250e5d42e","name":"21% rate","code":"21_RATE"},"merchant":null,"softSplitType":null,"taxRates":[{"taxRateId":"47db2d5f-f16d-4fd0-9691-9929fc59ba23","name":"21% rate","rate":21.0,"baseAmount":250.0,"taxAmount":52.50,"subtotal":302.50,"xpdReference":"XPD071740127","expenseGuid":"b01fd6d2-7439-4ea4-9aea-b32385850083"},{"taxRateId":"c3cfd1d2-f94d-41b0-a3e4-6eeccd8aa00a","name":"6% rate","rate":6.0,"baseAmount":150.0,"taxAmount":9.0,"subtotal":159.0,"xpdReference":"XPD071740127","expenseGuid":"2c8333f4-f6d5-4314-ab89-4927cf3a8d59"}]},"mileage":null,"perDiem":null,"customFieldValues":[{"customFieldId":"8252f509-66b9-430e-865f-cc9c94707b3b","customFieldName":"Free text Custom field","customFieldType":"Text","listItemId":null,"listItemName":null,"textValue":"free text"},{"customFieldId":"c2d33301-e053-48eb-95a4-d9655ee5613f","customFieldName":"Amount verified","customFieldType":"List","listItemId":"7f065da9-ba56-481d-a326-c365b68ad794","listItemName":"Yes","textValue":null}],"exchangeRates":[{"convertedAmount":431.25,"currencyCode":"GBP","rate":1.136177868570791},{"convertedAmount":480.28,"currencyCode":"USD","rate":1.020204918353779}],"attendees":[{"userId":"8fcb1822-eea7-4ffc-99e8-862460a6102c","type":"Internal","startsAt":15,"length":12,"email":"polly.ester@digital-corp.com","fullName":"Polly Ester","externalOrganization":null},{"userId":"ef46965d-06bc-4d67-8865-7480a54264a0","type":"External","startsAt":32,"length":13,"email":"ivana.tinkle@ltp-consultancy.be","fullName":"Ivana Tinkle","externalOrganization":"LTP Consultancy"}],"numberOfAttendees":3,"ownerExcluded":false,"amountPerAttendee":163.33,"flags":{"isSplitExpense":false,"isReimbursable":true,"hasAttachments":false}} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns not found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/submit": { "put": { "tags": [ "Expenses" ], "summary": "Submits an expense", "operationId": "V3ExpensesSubmitExpense", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The submit expense request in body", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseRequest" } } } }, "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/recall": { "put": { "tags": [ "Expenses" ], "summary": "Recalls an expense", "operationId": "V3ExpensesRecallExpense", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/approve": { "put": { "tags": [ "Expenses" ], "summary": "Approves an expense", "operationId": "V3ExpensesApproveExpense", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/unapprove": { "put": { "tags": [ "Expenses" ], "summary": "Unapproves an expense", "operationId": "V3ExpensesUnapproveExpense", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/control": { "put": { "tags": [ "Expenses" ], "summary": "Controls an expense", "operationId": "V3ExpensesControl", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/uncontrol": { "put": { "tags": [ "Expenses" ], "summary": "Uncontrols an expense", "operationId": "V3ExpensesUncontrol", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/reject": { "put": { "tags": [ "Expenses" ], "summary": "Rejects an expense", "operationId": "V3ExpensesRejectExpense", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The request in body", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/RejectExpenseRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RejectExpenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RejectExpenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RejectExpenseRequest" } } } }, "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/report": { "put": { "tags": [ "Expenses" ], "summary": "Reports an expense", "operationId": "V3ExpensesReport", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/unreport": { "put": { "tags": [ "Expenses" ], "summary": "Unreports an expense", "operationId": "V3ExpensesUnreport", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense in route", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "If expense is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses": { "post": { "tags": [ "Expenses" ], "summary": "Adds an expense", "operationId": "V3ExpensesAddExpense", "requestBody": { "description": "The request in body", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddExpenseRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddExpenseRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddExpenseRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddExpenseRequest" } } } }, "responses": { "201": { "description": "Returns HTTP status 201 if resource is created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddExpenseResponse" } } } }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/{id}/extended": { "get": { "tags": [ "Expenses" ], "operationId": "V3ExpensesGetExpenseByIdExtended", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "PotentialDuplicateType", "in": "query", "description": "The potential duplicate type that we want to return (User, Company, null)", "schema": { "enum": [ "User", "Company" ], "type": "string" } }, { "name": "Currencies", "in": "query", "description": "List of currency codes for which to provide converted expense amount.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetExpenseByIdExtendedResponse" }, "example": {"id":"38b92c20-0ecd-4f0a-8322-8c131629387b","user":{"id":"1bb77706-4c64-4d09-938a-84727f184807","firstName":"Karl","lastName":"Schwarz","email":"karl.swcharz@digital-corp.com","externalId":"USR003","countryCode":"GER","customFields":[{"key":"UserLocation","value":"Brussels","valueCode":"BRU"}]},"xpdReference":"XPD071740127","expenseDate":"2022-10-01T00:00:00","uploadDate":"0001-01-01T00:00:00","uploadSource":null,"expenseType":"Regular","expenseStatus":"Submitted","comment":"Had lunch with @Polly Ester and @Ivana Tinkle","amount":489.98,"currencyCode":"EUR","companyCurrencyCode":null,"group":{"id":"1d5abe90-1e14-49cd-98bd-14c0d204a967","name":"Marketing","groupId":"MRKT01"},"branch":{"id":"7936c7b3-1ab2-47dd-8c43-0a3ce508d44c","name":"Belgium","countryCode":"BEL","currencyCode":"GBP"},"category":{"id":"f6583f49-ecaf-4b33-b78d-9056dbf5f7c1","name":"Lunch","accountingCode":"some code","secondaryCode":"some secondary code"},"project":{"id":"235aa001-fe85-4cd1-887c-096cded41313","name":"Pilot for customer","projectId":"PILOT1"},"countryCode":"BEL","location":{"id":"4c0f5cfd-5380-4e2a-bd93-54c060bf6b8e","city":"Mechelen","region":"Flanders","country":"Belgium","geoLocation":{"latitude":51.02574,"longitude":4.47762}},"trip":{"id":"56911195-4786-4600-ae67-2cb7d14e85af","name":"Trip from Germany to Belgium","tripId":"TRP002317660","comment":"Conference trip","start":"0001-01-01T00:00:00+00:00","end":"0001-01-01T00:00:00+00:00"},"receipt":{"id":"a3413502-50a5-4394-96b1-1205e560b794","originalLink":"https://api.rydoo.com/v3/receipts/223de18a-a8d3-4fc6-8cc7-d5c4b10e6cca?version=Original","signedPdfLink":"https://api.rydoo.com/v3/receipts/223de18a-a8d3-4fc6-8cc7-d5c4b10e6cca?version=SignedPdf"},"regular":{"taxPercentage":21.0,"taxAmount":52.50,"netAmount":404.94,"matchStatus":"NoMatch","checkInDate":"2022-09-28T00:00:00","checkOutDate":"2022-10-03T00:00:00","paymentMethod":{"id":"a9c28e3f-f98a-4f95-b2a7-97292000b990","name":"Cash","type":"Cash","ownership":"Personal"},"advance":{"id":"91fd7ca4-a2b9-4b52-9a04-f1992ba06dcc","name":"Cash advance"},"taxRate":{"id":"f77ab969-2602-4b49-b27a-e534f95097b6","name":"21% rate","code":"21_RATE"},"merchant":{"id":"0ed4a422-5e3a-4ce5-8ab1-3fda863b49f1","name":"Lunch Hub Belgie","merchantVatNumber":"BE65749264282"},"matchedTransaction":null,"isInvoice":true,"invoiceNumber":"INV-2022-09-001"},"mileage":{"rate":{"id":"89bf41fb-6937-497e-bf65-d486bb9a3c5a","name":"Car rate","code":"CarRate2024"},"distanceKm":60.5,"isBackAndForth":true,"wayPoints":[{"location":"Brussels, Belgium"},{"location":"Mechelen, Belgium"},{"location":"Antwerp, Belgium"}]},"perDiem":{"startDate":null,"endDate":null,"duration":null,"rate":null,"region":null,"appliedRateAmount":202.50,"deductions":[{"id":"ef74cf6c-5b98-4e67-8c51-8a5eef28e4a2","name":"Breakfast","amount":20.50},{"id":"81206d1a-ad16-4a74-b626-ff56ffd59ec0","name":"Dinner","amount":35.50}],"supplements":[{"id":"80d007e9-1c39-4e11-bc38-70f8af2f8b28","name":"Late check-in","amount":10.50},{"id":"39b8852e-3f83-4a32-ab24-bc48a8bec625","name":"Flight delay","amount":15.50}]},"customFieldValues":[{"customFieldId":"edcdef84-6200-49a1-bb93-813d0c1b4785","customFieldName":"Free text Custom field","customFieldType":"Text","listItemId":null,"listItemName":null,"textValue":"free text"},{"customFieldId":"ae43bfa3-1fef-48de-9fb4-f714afaaa596","customFieldName":"Amount verified","customFieldType":"List","listItemId":"0b7998d5-8139-48b7-ab96-43a9b18adee8","listItemName":"Yes","textValue":null}],"exchangeRates":[{"convertedAmount":431.25,"currencyCode":"GBP","rate":1.136177868570791},{"convertedAmount":480.28,"currencyCode":"USD","rate":1.020204918353779}],"attendees":[{"userId":"09b776bf-cd7f-4b39-be61-0612309b2752","type":"Internal","startsAt":15,"length":12,"email":"polly.ester@digital-corp.com","fullName":"Polly Ester","externalOrganization":null},{"userId":"39bd1a48-0259-4721-a3c0-bd917de95356","type":"External","startsAt":32,"length":13,"email":"ivana.tinkle@ltp-consultancy.be","fullName":"Ivana Tinkle","externalOrganization":"LTP Consultancy"}],"potentialDuplicates":["b9c35983-87e5-494b-8676-f9b1f642f59b","90227671-859e-4f70-a478-92965b0920e8"],"ruleViolations":[{"ruleId":"5315db0c-d586-44b6-8b17-d97e26c8501b","ruleName":"1000 euro rule","ruleMessage":"Expense is over 1000 euros of {{totalAmount}}","totalAmount":1230.98,"severityLevel":"Warning"}],"changedInfo":["Date","Amount","Currency","ExchangeRate"],"activity":[{"action":"Created","timestamp":"2024-06-21T15:52:22.627+02:00","user":{"id":"204a3aa6-42a8-4307-b295-70b55d3f9a8a","firstName":"Karl","lastName":"Schwartz","email":"karl.swcharz@digital-corp.com","externalId":"USR003","countryCode":null},"authenticatedUser":null,"role":"Personal","rejectReason":null},{"action":"Processing","timestamp":"2024-06-21T15:52:22.657+02:00","user":{"id":"47b00cdb-297f-408d-b8dc-f3e58fc31d3a","firstName":"Karl","lastName":"Schwartz","email":"karl.swcharz@digital-corp.com","externalId":"USR003","countryCode":null},"authenticatedUser":null,"role":"Personal","rejectReason":null},{"action":"ToSubmit","timestamp":"2024-06-21T15:52:34.087+02:00","user":null,"authenticatedUser":null,"role":null,"rejectReason":null},{"action":"Submitted","timestamp":"2024-06-21T15:55:57.303+02:00","user":{"id":"a5e9c5f1-2623-43e5-b241-3d8801749151","firstName":"Karl","lastName":"Schwartz","email":"karl.swcharz@digital-corp.com","externalId":"USR003","countryCode":null},"authenticatedUser":null,"role":"Personal","rejectReason":null},{"action":"ReadyForPreApproval","timestamp":"2024-06-21T15:55:57.303+02:00","user":{"id":"152d7d78-134a-46e6-afb7-f5820a469332","firstName":"April","lastName":"Blanc","email":"april.blanc@digital-corp.com","externalId":"USR034","countryCode":null},"authenticatedUser":null,"role":"Approver","rejectReason":{"id":"039e7d21-1b3d-49b8-9fb5-59e15b72b205","title":"Missing Invoice","message":"Invoice is missing from the expense. Please correct it"}}],"flags":{"isSplitExpense":false,"isReimbursable":true,"hasAttachments":false},"auditFlags":null} } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/expenses/exported": { "get": { "tags": [ "ExportedExpenses" ], "summary": "Exported expenses", "operationId": "V3ExportedExpensesGetExportedExpenses", "parameters": [ { "name": "exportedAtStartDate", "in": "query", "description": "Beginning of time range for filtering expenses by export date", "schema": { "type": "string" } }, { "name": "exportedAtEndDate", "in": "query", "description": "End of time range for filtering expenses by export date", "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "Filter to only retrieve the expenses for 1 specific branch", "schema": { "type": "string" } }, { "name": "tripId", "in": "query", "description": "Filter to only retrieve the expenses of 1 specific trip", "schema": { "type": "string" } }, { "name": "onlyLatestVersions", "in": "query", "description": "Get only latest versions of expenses", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "description": "Filter to only retrieve the expenses of 1 specific user", "schema": { "type": "string" } }, { "name": "groupId", "in": "query", "description": "Filter to only retrieve the expenses for 1 specific group", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of expenses to return", "schema": { "type": "string" } }, { "name": "startingAfter", "in": "query", "description": "Cursor for paging: the id of the last expense from the previous page", "schema": { "type": "string" } }, { "name": "includeMultipleVatParent", "in": "query", "description": "Whether to include parent expenses of multiple VAT rates", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_Object" }, "example": {"data":[{"exportedAt":"2021-01-22T13:45:09Z","expenseId":"e5b1dec2-afec-4201-8c93-09ffa479418c","refId":"XPD012216312","type":"RegularExpense","amount":1120.0,"netAmount":1000.0,"currency":"EUR","expenseDate":"2021-01-02","merchant":"Four Seasons","merchantEnterpriseNumber":"58325","comment":null,"expenseStatus":"Approved","isReimbursable":false,"image":{"url":"https://streaming.rydoo.com/Receipt/original/9c843341-af19-4003-84bb-a1d29197beaa/9c843341-af19-4003-84bb-a1d29197beaa/1b43875e-633e-43ac-8a1c-ad1fd023c490","base64String":"data:image/jpeg;base64,/9j/4AAQSkZJRgABAgAAZABkAAD/7AARRHVja3kAAQAEAAAAPAAA/+4ADkFkb2JlAGTAAAAAAf/bAIQABgQEBAUEB...H/9k=","fileExtension":"JPEG"},"attachments":[{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/e8704947-9d56-462b-ae4a-7c1a5a2ff7da/download/false/Expense?d=24032021121727"},{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/f7f5fd35-5fd0-4b28-adc2-d518fadc0fbc/download/false/Expense?d=21122021121616"}],"attendees":[{"id":"eeb86106-57a2-4c2e-8dc5-0e3e704eb880","fullName":"Amalia Claupfer","email":"amelia@aurora.com","type":"Guest"},{"id":"67e2d9b4-6be1-44e9-a38d-469f96b6a2b3","fullName":"Sandra Malcory","email":"sandra.malcory@aurora.com","type":"User"}],"branch":{"branchId":"1f0ee19a-b40d-e711-81fc-005156bf1aff","refId":"110","name":"ACMECorp Canada","enterpriseNumber":"110","currency":"CAD","amount":1756.51,"netAmount":1568.31,"taxAmount":188.2},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"77738a64-a25d-438f-98d5-5431ee47d84b","refId":"123456","firstName":"Kate","lastName":"Friedman","email":"kate.friedman@acmecorp.com","iban":"BE123145678901"},"category":{"categoryId":"b5a46e5c-1886-4177-81c3-2ce1114be869","name":"Hotels (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[{"customFieldId":"3c0f8d45-bbd1-4c16-89c8-75cf8d9d7ea9","name":"Office location","isRequired":true,"isEnabled":true,"value":"Toronto","code":"490"}],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":null,"invoice":{"isInvoice":true,"invoiceNumber":"PL68392"},"meansOfPayment":{"paymentMethodId":"fe5hc4b3-9767-4ebf-1084-2ebba4771ede","paymentMethod":"CreditCard","name":"CompanyCreditCard","cardOwnership":"CompanyCard","cardNumber":"5032","accountNumber":"0532013000","travellerId":null,"matchStatus":"Confirmed","transactions":[{"processorTransactionId":"111-9000474744547474","mcFinancialTransactionId":"0446576452083664145840","acquirerReferenceNumber":"5920486820"}]},"calculatedCurrencies":[{"amount":1312.68,"netAmount":1172.04,"currency":"USD","taxAmount":140.64},{"amount":28809.4,"netAmount":25722.68,"currency":"MXN","taxAmount":3086.72}],"taxRate":{"taxAmount":120.0,"taxRate":12.0,"taxCode":"CAN Purchases 12%","subRates":[{"amount":50.0,"rate":5.0,"name":"GST"},{"amount":70.0,"rate":7.0,"name":"PST"}]},"hotel":{"checkIn":"2021-01-01T10:00:00","checkOut":"2021-01-02T10:00:00","numberOfNights":1},"location":{"countryCode":"CA","country":"Canada","region":"Ontario","city":"Toronto"},"linkTravel":null,"perDiem":null,"mileage":null,"history":{"submittedAt":"2021-01-02T10:00:00","approvedAt":"2021-01-04T11:06:12.793","approvedBy":"approver@acmecorp.com","controlledAt":null,"controlledBy":null},"rejectReasons":[{"title":"Duplicated expense","type":"Duplicate"}],"countrySpecific":null,"parentExpenseId":"ac20133e-ddc7-44a9-b78c-ef7247ce8405","hasChildren":false},{"exportedAt":"2021-01-03T15:23:03Z","expenseId":"9e237a2c-0580-4c9e-9b87-7ff2a070ab84","refId":"XPD012216312","type":"Mileage","amount":82.75,"netAmount":78.0,"currency":"MXN","expenseDate":"2021-01-06","merchant":null,"merchantEnterpriseNumber":null,"comment":null,"expenseStatus":"Controlled","isReimbursable":true,"image":null,"attachments":[{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/e8704947-9d56-462b-ae4a-7c1a5a2ff7da/download/false/Expense?d=24032021121727"},{"url":"https://streaming.rydoo.com/attachment/fe8e2033-4c60-470c-aad0-c7ab7bcca620/fe8e2033-4c60-470c-aad0-c7ab7bcca620/f7f5fd35-5fd0-4b28-adc2-d518fadc0fbc/download/false/Expense?d=21122021121616"}],"branch":{"branchId":"5c5d9e27-b33b-4bfb-b585-1cbcda0f1443","refId":"113","name":"ACMECorp Mexico","enterpriseNumber":"113","currency":"MXN","amount":82.75,"netAmount":78.0,"taxAmount":4.75},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"10b2bd0f-723b-44e9-a392-f35462827fbc","refId":"654321","firstName":"John","lastName":"Smith","email":"john.smith@acmecorp.com","iban":"BE123145671457"},"category":{"categoryId":"046fbf87-4d67-4db0-84ab-cd66f835611f","name":"Mileage (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":null,"invoice":{"isInvoice":false,"invoiceNumber":null},"meansOfPayment":{"paymentMethodId":"b1ef1bdd-5e6a-4679-a4b9-eca5e26cede7","paymentMethod":"Cash","name":"Cash","cardOwnership":"Personal","cardNumber":null,"accountNumber":"0532013000","travellerId":null,"matchStatus":"None","transactions":[]},"calculatedCurrencies":[],"taxRate":{"taxAmount":4.75,"taxRate":6.0906,"taxCode":"MXN Mileage","subRates":[]},"hotel":null,"location":{"countryCode":"MX","country":"Mexico","region":"Mexico","city":"Mexico City"},"linkTravel":null,"perDiem":null,"mileage":{"mileageRateName":"Own car (domestic and abroad) 2,50 MXN/km","from":"Mexico City, Mexico","to":"Toxcuca, Mexico","distance":33.1,"isBackAndForth":false,"distanceUnit":"km","mileageRates":{"mainRate":{"rate":2.5,"code":"135-0000296","distance":33.1},"subRates":[{"rate":1.4252,"code":"S20","distance":10.0},{"rate":3.0,"code":"S30","distance":270.0}]}},"history":{"submittedAt":"2021-01-07T12:00:00","approvedAt":"2021-01-07T17:21:56.128","approvedBy":"approver@acmecorp.com","controlledAt":"2021-01-08T17:21:56.128","controlledBy":"controller@acmecorp.com"},"rejectReasons":[],"countrySpecific":{"mexico":{"validationStatus":"Valid","cfdiGuid":"318b0fe6-235f-499d-adbb-e517b24c6ckd","rfcNumber":"RCS070607MF9","invalidReason":null}},"parentExpenseId":null,"hasChildren":false},{"exportedAt":"2021-01-03T15:23:03Z","expenseId":"020c3bd9-1aac-42ac-973a-6ebbfab7bef4","refId":"XPD012216312","type":"PerDiem","amount":55.0,"netAmount":52.04,"currency":"NOK","expenseDate":"2021-01-03","merchant":null,"merchantEnterpriseNumber":null,"comment":"Business trip","expenseStatus":"Controlled","isReimbursable":true,"image":null,"attachments":[],"branch":{"branchId":"1f0ee19a-b40d-e711-81fc-005156bf1aff","refId":"111","name":"ACMECorp Norway","enterpriseNumber":"111","currency":"NOK","amount":55.0,"netAmount":52.04,"taxAmount":2.96},"group":{"groupId":"ed82ege0-696a-4739-bfd6-cau25b5249ea","refId":"2105645","name":"2105645 Reporting Department"},"user":{"userId":"10b2bd0f-723b-44e9-a392-f35462827fbc","refId":"654321","firstName":"John","lastName":"Smith","email":"john.smith@acmecorp.com","iban":"BE123145671457"},"category":{"categoryId":"9e1f22f5-b96f-47de-9bcf-cc2cb54d6477","name":"Per Diem (employees)","isActive":true,"accountingCode":null,"secondaryCode":null},"customFields":[],"project":{"projectId":"db797814-aed2-46d8-9ad6-7e818caa815a","refId":"1100056111","name":"ACMECorp Reports"},"trip":{"tripId":"1e99a49a-1091-4c7f-55fa-61503f5bd560","refId":"TRP013156185","name":"Oslo trip","startDate":"2021-01-02T20:00:00","endDate":"2021-01-03T12:00:00"},"invoice":{"isInvoice":false,"invoiceNumber":null},"meansOfPayment":{"paymentMethodId":"b1ef1bdd-5e6a-4679-a4b9-eca5e26cede7","paymentMethod":"Cash","name":"Cash","cardOwnership":"Personal","cardNumber":null,"accountNumber":"0532013000","travellerId":null,"matchStatus":"None","transactions":[]},"calculatedCurrencies":[],"taxRate":{"taxAmount":2.96,"taxRate":5.69,"taxCode":"NOK Per Diem","subRates":[]},"hotel":null,"location":{"countryCode":"NO","country":"Norway","region":"Norway","city":"Oslo"},"linkTravel":{"linkId":"605320","linkCode":"8LOJSF","bookingId":"2121324"},"perDiem":{"rate":{"amount":55.0,"name":"Allowance with overnight stay","code":"111-0000111"},"duration":"16:00","region":"Norway","currency":"NOK","deductions":[{"name":"Lunch","code":"222-0000222","amount":8.2}],"supplements":[{"name":"Overnight","code":"OVE","amount":30.0}]},"mileage":null,"history":{"submittedAt":"2021-01-03T12:00:00","approvedAt":"2021-01-05T17:21:56.128","approvedBy":"approver@acmecorp.com","controlledAt":"2021-01-06T17:21:56.128","controlledBy":"controller@acmecorp.com"},"rejectReasons":[],"countrySpecific":null,"parentExpenseId":null,"hasChildren":false}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}": { "get": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesIsExportPerBranchesEnabled", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_State" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesEnableExportPerBranches", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/State" } }, "application/json": { "schema": { "$ref": "#/components/schemas/State" } }, "text/json": { "schema": { "$ref": "#/components/schemas/State" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/State" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_State" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/folders": { "get": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesGetFolders", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_FtpFolder" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/folderstate": { "post": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesSetFolderState", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FolderStateRequestModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FolderStateRequestModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FolderStateRequestModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FolderStateRequestModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_State" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/unassignedbranches": { "get": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesGetUnassignedBranches", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "schema": { "type": "string", "default": "Name" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_Branch" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/folder/{folderId}": { "get": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesGetFolderDetails", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_FtpFolderDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesEditFolder", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "folderId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_FtpFolder" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/folder": { "post": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesCreateFolder", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FtpFolderDetails" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_FtpFolderDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/mainftpconnection": { "get": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesGetMainFtpConnection", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_FtpConnection" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/exportperbranches/{companyGUID}/ftpconnection/{connectionId}": { "put": { "tags": [ "ExportPerBranches" ], "operationId": "V2ExportPerBranchesEditFtpConnection", "parameters": [ { "name": "companyGUID", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "connectionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FtpConnection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FtpConnection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FtpConnection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/FtpConnection" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_FtpConnection" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/external-organizations": { "post": { "tags": [ "ExternalOrganizations" ], "summary": "Create external organization", "operationId": "V2ExternalOrganizationsCreateExternalOrganization", "requestBody": { "description": "External organization to create", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ExternalOrganization" }, "example": {"name":"Doctors Ltd."} }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalOrganization" }, "example": {"name":"Doctors Ltd."} }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalOrganization" }, "example": {"name":"Doctors Ltd."} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalOrganization" }, "example": {"name":"Doctors Ltd."} } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "ExternalOrganizations" ], "summary": "Get a list of external organizations", "operationId": "V2ExternalOrganizationsGetExternalOrganizations", "parameters": [ { "name": "search", "in": "query", "description": "Filter on the external organizations where the name contains this string", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of external organizations to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of external organizations to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ExistingExternalOrganization" }, "example": {"data":[{"id":"3a3cfce4-5409-43a9-a67c-d003966837c9","name":"Doctors Ltd."},{"id":"001dec29-0cc6-4fa9-9d38-6a86bbd98fa0","name":"New Docs in Town"},{"id":"8bcf450c-c1e5-4734-8272-374d2808aab3","name":"Medical Services"}],"links":{"next":"/v2/companies/external?limit=3&offset=4"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/projects/{projectId}": { "get": { "tags": [ "Fields" ], "summary": "Get a specific project", "operationId": "V2FieldsGetProject", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you'd like to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonProject" }, "example": {"data":{"id":"4bde1204-4d20-4134-8a89-7a2e17dede79","name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Fields" ], "summary": "Update a project", "operationId": "V2FieldsUpdateProject", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you want to edit", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PartialUpdate_Of_CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/PartialUpdate_Of_CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/PartialUpdate_Of_CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PartialUpdate_Of_CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonProject" }, "example": {"data":{"id":"f2bc6a38-d091-4e99-9c84-808fddca70f8","name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]},"messages":[{"code":0,"message":"project successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/projects": { "get": { "tags": [ "Fields" ], "summary": "Get all projects", "operationId": "V2FieldsGetProjects", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "limit", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CommonProjectSummary" }, "example": {"data":[{"id":"1b4a7472-d916-4bd8-b60e-cbd6a2dca3e3","name":"string","isActive":true,"refId":"string"},{"id":"801fae1d-df5b-4498-b030-daa2a61732ae","name":"string","isActive":true,"refId":"string"}],"links":{"next":"/v2/projects?limit=1&offset=2&sort=Name&isActive=true&search=a","count":"/v2/projects/count?isActive=true&search=a"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/projects/count": { "get": { "tags": [ "Fields" ], "summary": "Number of projects", "operationId": "V2FieldsGetCount", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "isActive", "in": "query", "description": "The Id of the field", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "The Id of the field", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/project": { "post": { "tags": [ "Fields" ], "summary": "Create a project", "operationId": "V2FieldsAddProject", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CommonProject" }, "example": {"name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonProject" }, "example": {"data":{"id":"92d6679a-b9de-44eb-a9ca-d2f27a55c75b","name":"string","isActive":true,"refId":"string","customFields":[{"key":"string","value":"string","valueCode":"string"},{"key":"string","value":"string","valueCode":"string"}]},"messages":[{"code":0,"message":"project successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/projects/{projectId}/approver": { "get": { "tags": [ "Fields" ], "summary": "Retrieve project approvers", "operationId": "V2FieldsGetProjectApprovers", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you want to retrieve approvers for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ProjectApprovers" }, "example": {"data":{"expenseApprovers":[{"userId":"7a9551e2-e168-4dcd-96c7-c33127e3a999"}],"expenseConflictApprovers":[{"userId":"fa84ef55-8a78-4b53-ae0f-07349cb72ca1"}],"travelApprovers":[{"userId":"60c9f7a1-c4d9-409e-8c4e-67b0ae8a5cd2"}],"travelConflictApprovers":[{"userId":"bec3870d-dbd7-4722-98b5-c9694c4a1f5a"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Fields" ], "summary": "Assign project approvers", "operationId": "V2FieldsUpdateProjectApprovers", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you want to assign approvers for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The Id of the project you want to assign approvers for", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectApprovers" }, "example": {"expenseApprovers":[{"userId":"94479dcf-b33c-4b61-960e-0e0815f9c127"}],"expenseConflictApprovers":[{"userId":"3f0bddf3-dd57-4659-a419-747edc8135b1"}],"travelApprovers":[{"userId":"ad5bbb9b-0d8c-4b91-b968-6d8b57e99fe4"}],"travelConflictApprovers":[{"userId":"18e05494-4b99-4f3e-bcb5-4a00e6ada4ba"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectApprovers" }, "example": {"expenseApprovers":[{"userId":"94479dcf-b33c-4b61-960e-0e0815f9c127"}],"expenseConflictApprovers":[{"userId":"3f0bddf3-dd57-4659-a419-747edc8135b1"}],"travelApprovers":[{"userId":"ad5bbb9b-0d8c-4b91-b968-6d8b57e99fe4"}],"travelConflictApprovers":[{"userId":"18e05494-4b99-4f3e-bcb5-4a00e6ada4ba"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectApprovers" }, "example": {"expenseApprovers":[{"userId":"94479dcf-b33c-4b61-960e-0e0815f9c127"}],"expenseConflictApprovers":[{"userId":"3f0bddf3-dd57-4659-a419-747edc8135b1"}],"travelApprovers":[{"userId":"ad5bbb9b-0d8c-4b91-b968-6d8b57e99fe4"}],"travelConflictApprovers":[{"userId":"18e05494-4b99-4f3e-bcb5-4a00e6ada4ba"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectApprovers" }, "example": {"expenseApprovers":[{"userId":"94479dcf-b33c-4b61-960e-0e0815f9c127"}],"expenseConflictApprovers":[{"userId":"3f0bddf3-dd57-4659-a419-747edc8135b1"}],"travelApprovers":[{"userId":"ad5bbb9b-0d8c-4b91-b968-6d8b57e99fe4"}],"travelConflictApprovers":[{"userId":"18e05494-4b99-4f3e-bcb5-4a00e6ada4ba"}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ProjectApprovers" }, "example": {"data":{"expenseApprovers":[{"userId":"40b4ac28-6478-47f2-a385-66d5f61b33f7"}],"expenseConflictApprovers":[{"userId":"01b71290-f919-4cc3-a04c-ce70891f467e"}],"travelApprovers":[{"userId":"3e69a86a-7e19-48a2-8c43-03e5a8e65c72"}],"travelConflictApprovers":[{"userId":"0a9fda38-d04e-4256-ba80-7a2dbca64d49"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/fields/{fieldId}/projects/{projectId}/controller": { "get": { "tags": [ "Fields" ], "summary": "Retrieve project controllers", "operationId": "V2FieldsGetProjectControllers", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you want to retrieve controllers for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ProjectControllers" }, "example": {"data":{"controllers":[{"userId":"4b81b64c-f4c6-4996-bab1-d373b5413ac3"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Fields" ], "summary": "Assign project controllers", "operationId": "V2FieldsUpdateProjectControllers", "parameters": [ { "name": "fieldId", "in": "path", "description": "The Id of the field", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "projectId", "in": "path", "description": "The Id of the project you want to assign controllers for", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The Id of the project you want to retrieve controllers for", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectControllers" }, "example": {"controllers":[{"userId":"917c0e16-c116-4340-9572-753eeece18de"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectControllers" }, "example": {"controllers":[{"userId":"917c0e16-c116-4340-9572-753eeece18de"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectControllers" }, "example": {"controllers":[{"userId":"917c0e16-c116-4340-9572-753eeece18de"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectControllers" }, "example": {"controllers":[{"userId":"917c0e16-c116-4340-9572-753eeece18de"}]} } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ProjectControllers" }, "example": {"data":{"controllers":[{"userId":"4c0c21d1-d687-4d57-a6f8-9e24abe1799f"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/groups": { "get": { "tags": [ "Groups" ], "summary": "Get the groups in your company", "operationId": "V2GroupsGetGroups", "parameters": [ { "name": "limit", "in": "query", "description": "The number of groups to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of groups to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active groups (default is all groups)", "schema": { "type": "boolean" } }, { "name": "loadAllLevels", "in": "query", "description": "Marker to return all whole groups if parent group not scecified, despite to parents' value", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the groups where the name contain this string", "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "The unique identifier of the branch", "schema": { "type": "string", "format": "uuid" } }, { "name": "parentGroupId", "in": "query", "description": "The unique identifier of the parent group. If null, returns groups with parent null only", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchIds", "in": "query", "description": "The unique identifier of the branches", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_GroupSummary" }, "example": {"data":[{"id":"e17119be-70c3-4b49-b723-ce5b158bc745","name":"test_190","refId":"ref_190","branchId":"7c3e1cc1-a9a8-41e6-a155-2512002bc718","branchName":"branch_190","hasChildren":false,"isActive":true},{"id":"125fc3cb-295f-4cc8-a41b-d9cde5a3cfe4","name":"test_203","refId":"ref_203","branchId":"2d837d24-a1db-4b40-8c1c-32059ae6b051","branchName":"branch_203","hasChildren":false,"isActive":true}],"links":{"next":"/v2/groups?limit=1&offset=2&sort=Name&isActive=true&search=a&branchId=7f859080-8ff2-42b9-93f6-8c5733732260&parentGroupId=4872dbbd-a227-49f9-b4b3-b8aded98f00d","count":"/v2/groups/count?isActive=true&search=a&branchId=972d66a2-9068-4ed0-887a-e123c2b89433&parentGroupId=c686e71a-5d69-462c-ba61-3e9f368a51af"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Groups" ], "summary": "Add a group to the company", "operationId": "V2GroupsAddGroup", "requestBody": { "description": "The information of the group to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Group" }, "example": {"data":{"id":"10abcbba-9f5a-4340-bcab-835a0aeb0b97","parentGroup":{"id":"8b9d3989-b9c1-4692-a98c-b9f249fedcef","name":"gr_137","refId":"grref_137"},"name":"test_186","refId":"ref_186","branch":{"id":"da903e73-5c44-417f-bd16-e964bc9f01bb","name":"branch_115","refId":"ref_115"},"isActive":true},"messages":[{"code":0,"message":"group successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/groups/count": { "get": { "tags": [ "Groups" ], "summary": "The total count of all groups", "operationId": "V2GroupsGetCount", "parameters": [ { "name": "isActive", "in": "query", "description": "Filter on active groups (default is all groups)", "schema": { "type": "boolean" } }, { "name": "loadAllLevels", "in": "query", "description": "Marker to return all whole groups if parent group not scecified, despite to parents' value", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the groups where the name contain this string", "schema": { "type": "string" } }, { "name": "branchId", "in": "query", "description": "The unique identifier of the branch", "schema": { "type": "string", "format": "uuid" } }, { "name": "parentGroupId", "in": "query", "description": "The unique identifier of the parent group. If null, returns groups with parent null only", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/groups/{groupId}": { "get": { "tags": [ "Groups" ], "summary": "Get the specific group", "operationId": "V2GroupsGetGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the group", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Group" }, "example": {"data":{"id":"745b8e77-84d4-4c60-832f-172c131f99b0","parentGroup":{"id":"22403de4-8ee0-44a0-b070-d9df0005bdbc","name":"gr_228","refId":"grref_228"},"name":"test_119","refId":"ref_119","branch":{"id":"78effb9c-a054-428c-bc60-e9c44b9c92ed","name":"branch_156","refId":"ref_156"},"isActive":true},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Groups" ], "summary": "Update a group", "operationId": "V2GroupsEditGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the group", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the group with", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GroupChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GroupChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Group" }, "example": {"data":{"id":"0e8c4f7f-4600-4844-8e81-e5e56c95f02f","parentGroup":{"id":"23a15f38-00de-459c-9b41-5670a40b40cd","name":"gr_56","refId":"grref_56"},"name":"test_127","refId":"ref_127","branch":{"id":"d98082e2-804b-45ae-b14d-0ddfd28b19b5","name":"branch_226","refId":"ref_226"},"isActive":true},"messages":[{"code":0,"message":"group successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Groups" ], "summary": "Patch a group", "operationId": "V2GroupsPatchEditGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the group", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to patch the group with", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Group" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Groups" ], "summary": "Delete a group", "operationId": "V2GroupsDeleteGroup", "parameters": [ { "name": "groupId", "in": "path", "description": "The unique identifier of the group", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"messages":[{"code":0,"message":"group successfully deleted"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/groups/expensegroups": { "get": { "tags": [ "Groups" ], "summary": "Allow to get user expense groups", "operationId": "V2GroupsGetExpenseGroupsForUser", "parameters": [ { "name": "search", "in": "query", "description": "Allow to filter by group name", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "paging limit", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "paging offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "description": "provide active groups if expense date is part of the groupdate range.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ExpenseGroupSummaryModel" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/groups/expensegroups/count": { "get": { "tags": [ "Groups" ], "summary": "Allow to count the number of user expense groups", "operationId": "V2GroupsGetCountExpenseGroupsForUser", "parameters": [ { "name": "search", "in": "query", "description": "Allow to filter by group name", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "paging limit", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "paging offset", "schema": { "type": "integer", "format": "int32" } }, { "name": "date", "in": "query", "description": "provide active groups if expense date is part of the groupdate range.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/guests/company": { "post": { "tags": [ "Guests" ], "summary": "Create company-wide guest", "operationId": "V2GuestsCreateCompanyGuest", "requestBody": { "description": "Guest to create", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Guest" }, "example": {"fullName":"John Smith","email":"john.smith@doctorsltd.com","externalOrganizationId":"7da7219e-a527-4806-af51-08d801a11166"} }, "application/json": { "schema": { "$ref": "#/components/schemas/Guest" }, "example": {"fullName":"John Smith","email":"john.smith@doctorsltd.com","externalOrganizationId":"7da7219e-a527-4806-af51-08d801a11166"} }, "text/json": { "schema": { "$ref": "#/components/schemas/Guest" }, "example": {"fullName":"John Smith","email":"john.smith@doctorsltd.com","externalOrganizationId":"7da7219e-a527-4806-af51-08d801a11166"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Guest" }, "example": {"fullName":"John Smith","email":"john.smith@doctorsltd.com","externalOrganizationId":"7da7219e-a527-4806-af51-08d801a11166"} } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/identityProviders/{id}/certificates": { "get": { "tags": [ "IdentityProviders" ], "summary": "Get the SSO certificate.", "operationId": "V2IdentityProvidersGetSSOCertificates", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the SSO configuration", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SSOCertificates" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IdentityProviders" ], "summary": "Create the SSO certificate", "operationId": "V2IdentityProvidersAddSSOCertificate", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the SSO configuration", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "Public key", "content": { "application/json-patch+json": { "schema": { "type": "string" }, "example": "Success" }, "application/json": { "schema": { "type": "string" }, "example": "Success" }, "text/json": { "schema": { "type": "string" }, "example": "Success" }, "application/*+json": { "schema": { "type": "string" }, "example": "Success" } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SSOCertificate" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/identityProviders/certificates/{certificateId}": { "delete": { "tags": [ "IdentityProviders" ], "summary": "Delete specified certificate", "operationId": "V2IdentityProvidersRemoveSSOCertificate", "parameters": [ { "name": "certificateId", "in": "path", "description": "The unique identifier of the cetrificate", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/identityProviders": { "get": { "tags": [ "IdentityProviders" ], "summary": "Get configurations", "operationId": "V2IdentityProvidersGetSSOConfigurations", "parameters": [ { "name": "limit", "in": "query", "description": "The number of configurations to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of configurations to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Filter on configutations where the name or unique identifier contains this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_SSOConfiguration" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "IdentityProviders" ], "summary": "Create sso configuration", "operationId": "V2IdentityProvidersAddSSOConfiguration", "requestBody": { "description": "The SSO configuration information", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SSOConfiguration" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/identityProviders/count": { "get": { "tags": [ "IdentityProviders" ], "summary": "Get configurations count", "operationId": "V2IdentityProvidersGetSSOConfigurationsCount", "parameters": [ { "name": "search", "in": "query", "description": "Filter on configutations where the name or unique identifier contains this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/identityProviders/{id}": { "get": { "tags": [ "IdentityProviders" ], "summary": "Get specified configuration", "operationId": "V2IdentityProvidersGetSSOConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the configuration", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SSOConfiguration" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "IdentityProviders" ], "summary": "Update the SSO configuration", "operationId": "V2IdentityProvidersUpdateSSOConfiguration", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the confugration", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The configuration information", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SSOConfiguration" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SSOConfiguration" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/insights": { "get": { "tags": [ "Insights" ], "operationId": "V2InsightsGetInsights", "parameters": [ { "name": "reportName", "in": "query", "schema": { "type": "string" } }, { "name": "pageName", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_EmbedConfig" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/insights/datasets/refresh/{datasetId}": { "post": { "tags": [ "Insights" ], "operationId": "V2InsightsRefreshDataSet", "parameters": [ { "name": "datasetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/linkedaccounts/roles": { "get": { "tags": [ "LinkedAccounts" ], "summary": "Get a list of roles for linked accounts", "operationId": "V2LinkedAccountsGetRoles", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_List_Of_String" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/linkedaccounts": { "get": { "tags": [ "LinkedAccounts" ], "summary": "Get all linked accounts connections in the company", "operationId": "V2LinkedAccountsGetLinkedAccounts", "parameters": [ { "name": "limit", "in": "query", "description": "The number of linked accounts to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of linked accounts to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_LinkedAccountsAll" }, "example": {"data":[{"userId":"0710ae54-4ce4-46a4-bce6-2f68f525c212","linkedAccounts":[{"linkedAccountUserId":"941ba435-c271-4e0d-b4c5-7221e438a183","roles":["Admin","Personal"],"permissions":["AccessPersonalTransactions"]},{"linkedAccountUserId":"115426ad-5a0b-44b1-a1f2-4827adcfcdb8","roles":["Personal"],"permissions":["AccessPersonalTransactions"]}]},{"userId":"001d9b4b-b928-45fd-8057-d7ce6314755f","linkedAccounts":[{"linkedAccountUserId":"59c85c12-b26e-44e5-8a9d-b42303850163","roles":["Personal"],"permissions":["AccessPersonalTransactions"]}]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/linkedaccounts/count": { "get": { "tags": [ "LinkedAccounts" ], "summary": "Get count of linked accounts connections in the company", "operationId": "V2LinkedAccountsCountAllLinkedAccounts", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/mobile/refreshinterval": { "get": { "tags": [ "Mobile" ], "summary": "Get refresh interval to wait for after processing for an expense has started", "operationId": "V2MobileGetRefreshInterval", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_MobileSettings" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetConnection", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnection" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteAddConnection", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionBase" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionBase" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionBase" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionBase" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnection" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteUpdateConnection", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnection" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnection" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnection" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnection" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnection" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteDeleteConnection", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/test/auth": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteTestAuthorization", "parameters": [ { "name": "accessToken", "in": "query", "schema": { "type": "string" } }, { "name": "accessTokenSecret", "in": "query", "schema": { "type": "string" } }, { "name": "requestToken", "in": "query", "schema": { "type": "string" } }, { "name": "requestTokenSecret", "in": "query", "schema": { "type": "string" } }, { "name": "authorizationToken", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_NetSuiteLoginTestResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/settings/sync/active": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetSettingsWithActiveSyncProgress", "parameters": [ { "name": "settingIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_List_Of_Guid" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/test/connection": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteTestConnection", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/subsidiary": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetSubsidiary", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SubsidiaryDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteEditSubsidiary", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SubsidiaryDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SubsidiaryDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubsidiaryDetails" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SubsidiaryDetails" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_SubsidiaryDetails" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/subsidiary/all": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetAllSubsidiaries", "parameters": [ { "name": "AccessToken", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "RequestToken", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "RequestTokenSecret", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FormId", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_Branch" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/employee/byIds": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetEmployeesByIds", "parameters": [ { "name": "AccessToken", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "RequestToken", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "RequestTokenSecret", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "FormId", "in": "query", "schema": { "type": "string" } }, { "name": "employeeInternalIds", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_NetSuiteEmployee" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/settings/{id}": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetIntegrationConnectionSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnectionSetting" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteUpdateIntegrationConnectionSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnectionSetting" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteDeleteIntegrationConnectionSettings", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/settings": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteAddIntegrationConnectionSettings", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegrationConnectionSetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_IntegrationConnectionSetting" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSync", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/employees": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncEmployees", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/supervisors": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncSupervisors", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/taxgroups": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncTaxgroups", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/projects": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncProjects", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/accounts": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncAccounts", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/sync/categories": { "post": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteSyncCategories", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SyncModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SyncModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Boolean" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/accounts": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetCentralPaymentAccounts", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_BankAccount" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/netsuite-integration/forms": { "get": { "tags": [ "NetSuite" ], "operationId": "V2NetSuiteGetForms", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_IntegrationForm" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/notifications": { "get": { "tags": [ "Notifications" ], "summary": "Get the notifications about company expenses", "operationId": "V2NotificationsGetNotifications", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Notifications" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/all": { "get": { "tags": [ "PaymentMethods" ], "summary": "Get payment methods in your company", "operationId": "V2PaymentMethodsGetAllPaymentMethods", "parameters": [ { "name": "AccountType", "in": "query", "description": "Filter on AccountType. E.g.: CreditCard, Cash, etc.", "schema": { "type": "array", "items": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } } }, { "name": "BranchId", "in": "query", "description": "Filter on Branches with their Id", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdFilter" } } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "description": "Filter on IsActive state", "schema": { "type": "boolean" } }, { "name": "ValidationStatus", "in": "query", "description": "Filter on ValidationStatus. E.g.: None, Pending, Validated, etc.", "schema": { "type": "array", "items": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" } } }, { "name": "IsReimbursable", "in": "query", "description": "Filter on IsReimbursable flag", "schema": { "type": "boolean" } }, { "name": "CardNumber", "in": "query", "description": "Filter on CardNumber", "schema": { "type": "string" } }, { "name": "CardType", "in": "query", "description": "Filter on PaymentMethodCardType. E.g.: MasterCard, Amex, etc.", "schema": { "type": "array", "items": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string" } } }, { "name": "AccountOwnership", "in": "query", "description": "Filter on AccountOwnership. E.g.: Personal, Company.", "schema": { "type": "array", "items": { "enum": [ "Personal", "Company" ], "type": "string" } } }, { "name": "userId", "in": "query", "description": "Filter payment methods for a certain user", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_PaymentMethodSummaryResult" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods": { "get": { "tags": [ "PaymentMethods" ], "summary": "Get payment methods in your company", "operationId": "V2PaymentMethodsGetPaymentMethods", "parameters": [ { "name": "AccountType", "in": "query", "description": "Filter on AccountType. E.g.: CreditCard, Cash, etc.", "schema": { "type": "array", "items": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } } }, { "name": "BranchId", "in": "query", "description": "Filter on Branches with their Id", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdFilter" } } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "description": "Filter on IsActive state", "schema": { "type": "boolean" } }, { "name": "ValidationStatus", "in": "query", "description": "Filter on ValidationStatus. E.g.: None, Pending, Validated, etc.", "schema": { "type": "array", "items": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" } } }, { "name": "IsReimbursable", "in": "query", "description": "Filter on IsReimbursable flag", "schema": { "type": "boolean" } }, { "name": "CardNumber", "in": "query", "description": "Filter on CardNumber", "schema": { "type": "string" } }, { "name": "CardType", "in": "query", "description": "Filter on PaymentMethodCardType. E.g.: MasterCard, Amex, etc.", "schema": { "type": "array", "items": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string" } } }, { "name": "AccountOwnership", "in": "query", "description": "Filter on AccountOwnership. E.g.: Personal, Company.", "schema": { "type": "array", "items": { "enum": [ "Personal", "Company" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_PaymentMethodSummaryResult" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsAddPaymentMethod", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddPaymentMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddPaymentMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddPaymentMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddPaymentMethod" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PaymentMethodResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/all/count": { "get": { "tags": [ "PaymentMethods" ], "summary": "the total count of all payment methods in your company", "operationId": "V2PaymentMethodsGetAllCount", "parameters": [ { "name": "AccountType", "in": "query", "description": "Filter on AccountType. E.g.: CreditCard, Cash, etc.", "schema": { "type": "array", "items": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } } }, { "name": "BranchId", "in": "query", "description": "Filter on Branches with their Id", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdFilter" } } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "description": "Filter on IsActive state", "schema": { "type": "boolean" } }, { "name": "ValidationStatus", "in": "query", "description": "Filter on ValidationStatus. E.g.: None, Pending, Validated, etc.", "schema": { "type": "array", "items": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" } } }, { "name": "IsReimbursable", "in": "query", "description": "Filter on IsReimbursable flag", "schema": { "type": "boolean" } }, { "name": "CardNumber", "in": "query", "description": "Filter on CardNumber", "schema": { "type": "string" } }, { "name": "CardType", "in": "query", "description": "Filter on PaymentMethodCardType. E.g.: MasterCard, Amex, etc.", "schema": { "type": "array", "items": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string" } } }, { "name": "AccountOwnership", "in": "query", "description": "Filter on AccountOwnership. E.g.: Personal, Company.", "schema": { "type": "array", "items": { "enum": [ "Personal", "Company" ], "type": "string" } } }, { "name": "userId", "in": "query", "description": "Filter payment methods for a certain user", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/count": { "get": { "tags": [ "PaymentMethods" ], "summary": "the total count of all payment methods in your company", "operationId": "V2PaymentMethodsGetCount", "parameters": [ { "name": "AccountType", "in": "query", "description": "Filter on AccountType. E.g.: CreditCard, Cash, etc.", "schema": { "type": "array", "items": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } } }, { "name": "BranchId", "in": "query", "description": "Filter on Branches with their Id", "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdFilter" } } }, { "name": "Limit", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "Sort", "in": "query", "schema": { "type": "string" } }, { "name": "Search", "in": "query", "schema": { "type": "string" } }, { "name": "IsActive", "in": "query", "description": "Filter on IsActive state", "schema": { "type": "boolean" } }, { "name": "ValidationStatus", "in": "query", "description": "Filter on ValidationStatus. E.g.: None, Pending, Validated, etc.", "schema": { "type": "array", "items": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" } } }, { "name": "IsReimbursable", "in": "query", "description": "Filter on IsReimbursable flag", "schema": { "type": "boolean" } }, { "name": "CardNumber", "in": "query", "description": "Filter on CardNumber", "schema": { "type": "string" } }, { "name": "CardType", "in": "query", "description": "Filter on PaymentMethodCardType. E.g.: MasterCard, Amex, etc.", "schema": { "type": "array", "items": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string" } } }, { "name": "AccountOwnership", "in": "query", "description": "Filter on AccountOwnership. E.g.: Personal, Company.", "schema": { "type": "array", "items": { "enum": [ "Personal", "Company" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/{id}": { "get": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsGetPaymentMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PaymentMethodResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsEditPaymentMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditPaymentMethod" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditPaymentMethod" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditPaymentMethod" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditPaymentMethod" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PaymentMethodResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/sendreminder": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsSendValidationReminderMails", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/default": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsSetAsDefaultPaymentMethods", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/activate": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsActivatePaymentMethods", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/deactivate": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsDeactivatePaymentMethods", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/{id}/validationinfo": { "get": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsGetValidationInfo", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_PaymentMethodTransaction" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsValidatePaymentMethod", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PaymentMethodTransaction" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/enableautocreate": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsEnableAutoCreatePaymentMethods", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/disableautocreate": { "post": { "tags": [ "PaymentMethods" ], "operationId": "V2PaymentMethodsDisableAutoCreatePaymentMethods", "requestBody": { "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result_Of_PaymentMethodMultiActionResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/reasons": { "get": { "tags": [ "PolicyReasons" ], "summary": "Get Approve/Reject reasons in your company", "operationId": "V2PolicyReasonsGetPolicyReasons", "parameters": [ { "name": "limit", "in": "query", "description": "The number of reasons to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of reasons to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on Active reasons (default is all reasons)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on reasons where the Title contains this string", "schema": { "type": "string" } }, { "name": "reasonType", "in": "query", "description": "Filter on the reason type. It can be Approve or Reject (default is all reasons)", "schema": { "enum": [ "Approve", "Reject" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_PolicyReasonSummary" }, "example": {"data":[{"id":"4c898c4b-48a1-4c80-a403-f386c764203c","isActive":true,"reasonType":"Reject","rejectType":"DuplicateExpense","approveType":null,"title":null,"languages":["en-US"],"fallbackLanguage":"en-US"},{"id":"4862e271-c9aa-45da-8347-34f850d67b16","isActive":true,"reasonType":"Approve","rejectType":null,"approveType":"ReceiptOrInvoiceLost","title":null,"languages":["en-US"],"fallbackLanguage":"en-US"}],"links":{"next":"/v2/reasons?limit=2&offset=2","count":"/v2/reasons/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "PolicyReasons" ], "summary": "Add a reason to the company", "operationId": "V2PolicyReasonsAddPolicyReason", "requestBody": { "description": "The information of the reason to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PolicyReason" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/reasons/count": { "get": { "tags": [ "PolicyReasons" ], "summary": "The total count of all reasons", "operationId": "V2PolicyReasonsGetCount", "parameters": [ { "name": "isActive", "in": "query", "description": "Filter on Active reasons (default is all reasons)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on reasons where the Title contains this string", "schema": { "type": "string" } }, { "name": "reasonType", "in": "query", "description": "Filter on the reason type. It can be Approve or Reject (default is all reasons)", "schema": { "enum": [ "Approve", "Reject" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/reasons/{policyReasonId}": { "get": { "tags": [ "PolicyReasons" ], "summary": "Get the specific reason", "operationId": "V2PolicyReasonsGetPolicyReason", "parameters": [ { "name": "policyReasonId", "in": "path", "description": "The unique identifier of the reason", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PolicyReason" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "PolicyReasons" ], "summary": "Update a reason of the company", "operationId": "V2PolicyReasonsEditPolicyReason", "parameters": [ { "name": "policyReasonId", "in": "path", "description": "The unique identifier of the reason", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the reason with", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/PolicyReasonChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_PolicyReason" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "PolicyReasons" ], "summary": "Delete a reason", "operationId": "V2PolicyReasonsDeletePolicyReason", "parameters": [ { "name": "policyReasonId", "in": "path", "description": "The unique identifier of the reason", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/reasons/expenses": { "get": { "tags": [ "PolicyReasons" ], "summary": "Get policy reasons for expenses", "operationId": "V2PolicyReasonsGetPolicyReasonsForExpense", "parameters": [ { "name": "expenseIds", "in": "query", "description": "list of expenses that needs policy reasons", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "reasonType", "in": "query", "description": "type of the policy reason", "schema": { "enum": [ "Approve", "Reject" ], "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_PolicyReasonForExpenseSummary" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/projects": { "get": { "tags": [ "Projects" ], "summary": "Get the projects of the company", "operationId": "V2ProjectsGetProjects", "parameters": [ { "name": "limit", "in": "query", "description": "The number of groups to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of groups to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "enum": [ "Name" ], "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active groups (default is all groups)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the groups where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ProjectSummary" }, "example": {"data":[{"id":"608f2861-ec4f-421b-9731-e6bd5433937d","name":"project4_97","isActive":true,"refId":"ref_40","branchName":"branch_97"},{"id":"33aac582-9adf-4ce6-800d-037f2f1c9b07","name":"project4_130","isActive":true,"refId":"ref_197","branchName":"branch_130"}],"links":{"next":"/v2/projects?limit=1&offset=2&sort=Name&isActive=true&search=a","count":"/v2/projects/count?isActive=true&search=a"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "Projects" ], "summary": "Add a project to the company", "operationId": "V2ProjectsAddProject", "requestBody": { "description": "The information of the project to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Project" }, "example": {"data":{"id":"2d38ebe9-516e-4562-a73d-1f51b634dc32","name":"proj_233","isActive":true,"refId":"ref_235","branch":{"id":"6193dfb4-edb0-42db-8e0a-e65b7a31deb1","name":"branch_180","refId":"ref_180"},"limitedToGroups":[{"id":"7058cf57-d601-4f5b-bdb1-b4fa6578e72a","name":"gr_87","refId":"grref_87"}],"isDefaultForGroups":null},"messages":[{"code":0,"message":"project successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/projects/count": { "get": { "tags": [ "Projects" ], "summary": "The total count of projects", "operationId": "V2ProjectsGetCount", "parameters": [ { "name": "isActive", "in": "query", "description": "Filter on active groups (default is all groups)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the groups where the name contain this string", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/projects/{projectId}": { "get": { "tags": [ "Projects" ], "summary": "Get the specific project", "operationId": "V2ProjectsGetProject", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Project" }, "example": {"data":{"id":"b0b7f7bf-24a7-456d-b59a-307144140bd6","name":"proj_191","isActive":true,"refId":"ref_247","branch":{"id":"4de2beb3-5045-446f-82ae-0ff17256a0f7","name":"branch_179","refId":"ref_179"},"limitedToGroups":[{"id":"22c9dadb-7625-46e5-9a6e-a26584fe1996","name":"gr_219","refId":"grref_219"}],"isDefaultForGroups":null},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Projects" ], "summary": "Update a project", "operationId": "V2ProjectsEditProject", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information of the project to update it with", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Project" }, "example": {"data":{"id":"823326e4-da06-4442-a25a-d2a21e789430","name":"proj_228","isActive":true,"refId":"ref_38","branch":{"id":"c429edaf-ecbb-449d-8e81-4bdf35289a71","name":"branch_175","refId":"ref_175"},"limitedToGroups":[{"id":"7b5277af-9e9b-4820-ac76-10229a3314be","name":"gr_175","refId":"grref_175"}],"isDefaultForGroups":null},"messages":[{"code":0,"message":"project successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Projects" ], "summary": "Patch a project", "operationId": "V2ProjectsPatchEditProject", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to patch the project with", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Project" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/projects/{projectId}/approvers": { "get": { "tags": [ "Projects" ], "summary": "Returns approver and conflict approver assignments for the project", "operationId": "V2ProjectsGetProjectApproverAssignments", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverAssignment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Projects" ], "summary": "Edit approver and coflict approver assigments for project", "operationId": "V2ProjectsEditProjectApproverAssignments", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the approver and conflict approver assignments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ApproverAssignmentChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ApproverAssignmentChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ApproverAssignmentChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ApproverAssignmentChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ApproverAssignment_And_RoleAssignmentResult_And_RoleAssignmentResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/projects/{projectId}/controllers": { "get": { "tags": [ "Projects" ], "summary": "Returns controller and conflict controller assignments for project", "operationId": "V2ProjectsGetProjectControllerAssignments", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ControllerAssignment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Projects" ], "summary": "Edit controller and coflict controller assigments for project", "operationId": "V2ProjectsEditProjectControllerAssignments", "parameters": [ { "name": "projectId", "in": "path", "description": "The unique identifier of the project", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the controller and conflict controller assignments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ControllerAssignmentChange" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControllerAssignmentChange" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControllerAssignmentChange" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ControllerAssignmentChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ControllerAssignment_And_RoleAssignmentResult_And_RoleAssignmentResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/receipts/{id}": { "get": { "tags": [ "Receipts" ], "summary": "Downloads the binary file of the receipt", "operationId": "V3ReceiptsGetReceipt", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the receipt", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Version", "in": "query", "description": "The version of the receipt to be download.\r\nOriginal: The version the user uploaded in PNG, PDF, JPEG format.\r\nConvertedImage: The converted, lesser quality JPEG version of the original. Useful for UIs.\r\nSignedPdf: The signed version of the receipt as a proof that it hasn't been tempered with.", "schema": { "enum": [ "Original", "ConvertedImage", "SignedPdf" ], "type": "string" } }, { "name": "PageNumber", "in": "query", "description": "In case of ConvertedImage version each page should be downloaded separatly if the original receipt is a multi-page receipt like PDF.\r\nDefaults to 1.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error" }, "404": { "description": "If receipt is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/receipts": { "post": { "tags": [ "Receipts" ], "summary": "Uploads the binary file of the receipt", "operationId": "V3ReceiptsUploadReceipt", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "The bytes of the new file", "format": "binary" }, "UserId": { "type": "string", "description": "The Id of the User", "format": "uuid" } } }, "encoding": { "File": { "style": "form" }, "UserId": { "style": "form" } } } } }, "responses": { "200": { "description": "Returns HTTP status 200 if successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadReceiptResponse" } } } }, "400": { "description": "If input is invalid, returns error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v3/receipts/by-expense/{id}": { "get": { "tags": [ "Receipts" ], "summary": "Downloads the binary file of the signed pdf receipt based on the expense id", "operationId": "V3ReceiptsGetReceiptByExpenseId", "parameters": [ { "name": "id", "in": "path", "description": "The UUID of the expense", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Returns HTTP status 200 if successful" }, "400": { "description": "If input is invalid, returns error" }, "404": { "description": "If receipt is not found, returns error" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/referencedata": { "get": { "tags": [ "ReferenceData" ], "summary": "Returns reference data used throughout the Xpenditure application", "operationId": "V2ReferenceDataGet", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ReferenceData" }, "example": {"data":{"countries":[{"isoCode":"USA"},{"isoCode":"UKR"}],"currencies":[{"isoCode":"USD"},{"isoCode":"UAH"}],"languages":[{"culture":"da-DK"},{"culture":"pl-PL"}]},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v1/reimbursements": { "get": { "tags": [ "Reimbursements" ], "operationId": "V2ReimbursementsGetReimbursements", "parameters": [ { "name": "ModifiedFromDate", "in": "query", "description": "Filter reimbursements from this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedToDate", "in": "query", "description": "Filter reimbursements to this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "Status", "in": "query", "description": "Filter reimbursements by status", "schema": { "enum": [ "InProgress", "Succeeded", "Failed", "Cancelled" ], "type": "string" } }, { "name": "Limit", "in": "query", "description": "Maximum number of reimbursements to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Number of reimbursements to skip before starting to collect the result set", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_ReimbursementSummary" }, "example": {"data":[{"id":"1f49e384-47c4-4853-955d-c75df92c3de5","refId":"RMB1721296406","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":246.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD761496462","amount":{"value":1.0,"currencyCode":"EUR"}},{"refId":"XPD080305997","amount":{"value":12.0,"currencyCode":"EUR"}},{"refId":"XPD1125204313","amount":{"value":94.0,"currencyCode":"EUR"}},{"refId":"XPD1263435167","amount":{"value":29.0,"currencyCode":"EUR"}},{"refId":"XPD832591746","amount":{"value":36.0,"currencyCode":"EUR"}},{"refId":"XPD623698941","amount":{"value":74.0,"currencyCode":"EUR"}}]},{"id":"389e418d-fa90-4acb-970d-f1f14f17d084","refId":"RMB1070019018","walletId":"wallet-0","branchId":"f6b9df3a-cb90-4ddc-a624-6baa682fac99","amount":{"value":27.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD374117967","amount":{"value":27.0,"currencyCode":"EUR"}}]},{"id":"2db785b4-8a30-4cb6-9973-f79d78501b15","refId":"RMB0924184104","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":466.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD1375475187","amount":{"value":97.0,"currencyCode":"EUR"}},{"refId":"XPD1071630815","amount":{"value":84.0,"currencyCode":"EUR"}},{"refId":"XPD1139374254","amount":{"value":80.0,"currencyCode":"EUR"}},{"refId":"XPD1363576236","amount":{"value":56.0,"currencyCode":"EUR"}},{"refId":"XPD651770341","amount":{"value":12.0,"currencyCode":"EUR"}},{"refId":"XPD1703147912","amount":{"value":85.0,"currencyCode":"EUR"}},{"refId":"XPD1095621561","amount":{"value":52.0,"currencyCode":"EUR"}}]},{"id":"b039baca-af8b-4f6e-84a2-791cb38610f0","refId":"RMB1754799413","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":289.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD1443456238","amount":{"value":44.0,"currencyCode":"EUR"}},{"refId":"XPD835377393","amount":{"value":31.0,"currencyCode":"EUR"}},{"refId":"XPD476150852","amount":{"value":42.0,"currencyCode":"EUR"}},{"refId":"XPD1959313540","amount":{"value":86.0,"currencyCode":"EUR"}},{"refId":"XPD2115320831","amount":{"value":26.0,"currencyCode":"EUR"}},{"refId":"XPD347779359","amount":{"value":60.0,"currencyCode":"EUR"}}]},{"id":"b48a438d-658d-4771-80ce-ae4c2fc6eab3","refId":"RMB0914573668","walletId":"wallet-0","branchId":"f6b9df3a-cb90-4ddc-a624-6baa682fac99","amount":{"value":98.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD1561613034","amount":{"value":98.0,"currencyCode":"EUR"}}]},{"id":"f2f0c66a-80c1-4678-959b-e90160b7a0e3","refId":"RMB0159798336","walletId":"wallet-0","branchId":"f6b9df3a-cb90-4ddc-a624-6baa682fac99","amount":{"value":170.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD1900978886","amount":{"value":91.0,"currencyCode":"EUR"}},{"refId":"XPD2121848740","amount":{"value":35.0,"currencyCode":"EUR"}},{"refId":"XPD1942026749","amount":{"value":44.0,"currencyCode":"EUR"}}]},{"id":"0b171f00-41ac-4f3f-971c-20c947985702","refId":"RMB1627697143","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":392.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD259727516","amount":{"value":19.0,"currencyCode":"EUR"}},{"refId":"XPD1071428036","amount":{"value":48.0,"currencyCode":"EUR"}},{"refId":"XPD1398994099","amount":{"value":14.0,"currencyCode":"EUR"}},{"refId":"XPD927568014","amount":{"value":58.0,"currencyCode":"EUR"}},{"refId":"XPD058001684","amount":{"value":76.0,"currencyCode":"EUR"}},{"refId":"XPD116532160","amount":{"value":29.0,"currencyCode":"EUR"}},{"refId":"XPD450547244","amount":{"value":56.0,"currencyCode":"EUR"}},{"refId":"XPD509757073","amount":{"value":82.0,"currencyCode":"EUR"}},{"refId":"XPD2094344357","amount":{"value":10.0,"currencyCode":"EUR"}}]},{"id":"fa5dcdf8-7616-4442-b047-a9e53e3a40c6","refId":"RMB2072824917","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":72.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD853653782","amount":{"value":72.0,"currencyCode":"EUR"}}]},{"id":"11d96b75-76d9-402d-b651-c5743ebeb69e","refId":"RMB0712866404","walletId":"wallet-1","branchId":"af8e2eed-1090-4c3f-94b0-634af758acba","amount":{"value":469.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD819947570","amount":{"value":63.0,"currencyCode":"EUR"}},{"refId":"XPD1358807763","amount":{"value":34.0,"currencyCode":"EUR"}},{"refId":"XPD1367211646","amount":{"value":13.0,"currencyCode":"EUR"}},{"refId":"XPD1766937890","amount":{"value":76.0,"currencyCode":"EUR"}},{"refId":"XPD358907388","amount":{"value":13.0,"currencyCode":"EUR"}},{"refId":"XPD218886373","amount":{"value":75.0,"currencyCode":"EUR"}},{"refId":"XPD2018129717","amount":{"value":87.0,"currencyCode":"EUR"}},{"refId":"XPD1261468255","amount":{"value":45.0,"currencyCode":"EUR"}},{"refId":"XPD936381346","amount":{"value":63.0,"currencyCode":"EUR"}}]},{"id":"68fedf22-79b7-4d1c-8e09-7b9bb81120d3","refId":"RMB1276797972","walletId":"wallet-0","branchId":"f6b9df3a-cb90-4ddc-a624-6baa682fac99","amount":{"value":359.0,"currencyCode":"EUR"},"status":"Succeeded","reimbursedAt":"0001-01-01T00:00:00+00:00","expenses":[{"refId":"XPD478788104","amount":{"value":75.0,"currencyCode":"EUR"}},{"refId":"XPD913458939","amount":{"value":55.0,"currencyCode":"EUR"}},{"refId":"XPD1648113617","amount":{"value":64.0,"currencyCode":"EUR"}},{"refId":"XPD1015147243","amount":{"value":22.0,"currencyCode":"EUR"}},{"refId":"XPD2039565138","amount":{"value":29.0,"currencyCode":"EUR"}},{"refId":"XPD655261287","amount":{"value":30.0,"currencyCode":"EUR"}},{"refId":"XPD859597726","amount":{"value":36.0,"currencyCode":"EUR"}},{"refId":"XPD1716696087","amount":{"value":12.0,"currencyCode":"EUR"}},{"refId":"XPD1285217366","amount":{"value":36.0,"currencyCode":"EUR"}}]}],"links":{"next":"v1/reimbursements?Offset=10&Limit=10","count":"v1/reimbursements/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v1/reimbursements/count": { "get": { "tags": [ "Reimbursements" ], "operationId": "V2ReimbursementsGetReimbursementsCount", "parameters": [ { "name": "ModifiedFromDate", "in": "query", "description": "Filter reimbursements from this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "ModifiedToDate", "in": "query", "description": "Filter reimbursements to this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "Status", "in": "query", "description": "Filter reimbursements by status", "schema": { "enum": [ "InProgress", "Succeeded", "Failed", "Cancelled" ], "type": "string" } }, { "name": "Limit", "in": "query", "description": "Maximum number of reimbursements to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Number of reimbursements to skip before starting to collect the result set", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/build-reports": { "post": { "tags": [ "Reporting" ], "operationId": "V2ReportingBuildReports", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GenerateReportsModel" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GenerateReportsModel" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GenerateReportsModel" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GenerateReportsModel" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultMessage" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/taxrates": { "get": { "tags": [ "TaxRates" ], "summary": "Gets the tax rates for the company", "operationId": "V2TaxRatesGetTaxRates", "parameters": [ { "name": "limit", "in": "query", "description": "The number of tax rates to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of tax rates to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active tax rates (default is all tax rats)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the tax rates where the name contain this string", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "The isoCode of the country", "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "description": "The unique identifier of the category", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "query", "description": "The unique identifier of the branch", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_TaxRateSummary" }, "example": {"data":[{"id":"8269a40f-fc31-4b5d-ba7b-32426dd18d8e","name":"VAT_8269a40f-fc31-4b5d-ba7b-32426dd18d8e","shouldBeSelected":false},{"id":"cd49992d-8558-4cbc-a094-51e9e9fecb6c","name":"VAT_cd49992d-8558-4cbc-a094-51e9e9fecb6c","shouldBeSelected":false}],"links":{"next":"/v2/taxrates?limit=5&offset=10&isActive=true&search=v&branchId=065aa73b-6761-4472-b731-14b28fc3e938","count":"/v2/taxrates/count?isActive=true&search=v"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/taxrates/count": { "get": { "tags": [ "TaxRates" ], "summary": "The total count of all tax rates", "operationId": "V2TaxRatesGetCount", "parameters": [ { "name": "isActive", "in": "query", "description": "Filter on active tax rates (default is all tax rats)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the tax rates where the name contain this string", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "The isoCode of the country", "schema": { "type": "string" } }, { "name": "categoryId", "in": "query", "description": "The unique identifier of the category", "schema": { "type": "string", "format": "uuid" } }, { "name": "branchId", "in": "query", "description": "The unique identifier of the branch", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/transactions": { "post": { "tags": [ "Transactions" ], "summary": "Add a new transaction for a user", "operationId": "V2TransactionsAddTransaction", "requestBody": { "description": "Transaction to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddTransaction" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddTransaction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddTransaction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddTransaction" } } } }, "responses": { "201": { "description": "Created" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Transactions" ], "summary": "Get transactions of a company", "operationId": "V2TransactionsGetTransactions", "parameters": [ { "name": "PaymentMethodType", "in": "query", "description": "Filter by payment method type", "schema": { "enum": [ "DebitCard", "CreditCard", "Prepaid", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } }, { "name": "Status", "in": "query", "description": "Filter by transaction status", "schema": { "type": "array", "items": { "enum": [ "Failed", "Pending", "Reversed", "Completed", "Refunded" ], "type": "string" } } }, { "name": "FromTransactionDate", "in": "query", "description": "Filter transactions from this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToTransactionDate", "in": "query", "description": "Filter transactions to this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "MatchingStatus", "in": "query", "description": "Filter by transaction match statuses", "schema": { "type": "array", "items": { "enum": [ "None", "MatchFound", "Confirmed" ], "type": "string" } } }, { "name": "Limit", "in": "query", "description": "Maximum number of transactions to return", "schema": { "type": "integer", "format": "int32" } }, { "name": "Offset", "in": "query", "description": "Number of transactions to skip before starting to collect the result set", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_GetTransactionsResponse" }, "example": {"data":[{"id":"849d7bcf-c54e-45d1-b0ef-d857b68d63ba","processorTransactionId":"3e8dc3db-6bd5-46cf-a740-8b89a3144c6e","transactionDate":"2026-11-02T13:19:47.8470911Z","status":"Completed","merchant":"Office Supply Store","originalCurrency":"EUR","originalAmount":100.0,"billedCurrency":"USD","billedAmount":107.48,"matchingStatus":"Confirmed","matchedExpenses":[{"xpdId":"XPD000000636","expenseGuid":"158af5f7-fce6-42bc-a136-aa872cf5f963","status":"Completed"}],"paymentMethod":{"paymentMethodType":"Rydoo","cardNumber":"xxxx-xxxx-xxxx-9183"},"user":{"email":"user@rydoo.com"},"merchantCategory":{"code":"5817","description":"Digital goods - Applications"},"calculatedCurrencies":null,"additionalProperties":{"customerRefValue10":"F0011125658"}},{"id":"cf80f6e1-d52a-4a6b-ba4f-102736c6d41a","processorTransactionId":"951cc697-9887-41fa-997e-3b7d076f6611","transactionDate":"2026-11-02T13:19:47.8470943Z","status":"Completed","merchant":"Office Supply Store","originalCurrency":"EUR","originalAmount":100.0,"billedCurrency":"USD","billedAmount":107.48,"matchingStatus":"Confirmed","matchedExpenses":[{"xpdId":"XPD000000163","expenseGuid":"b6d314ed-6c26-4dea-a516-5b5e6e745a78","status":"Completed"}],"paymentMethod":{"paymentMethodType":"CreditCard","cardNumber":"4222-22xx-xxxx-9183"},"user":{"email":"user@rydoo.com"},"merchantCategory":{"code":"5817","description":"Digital goods - Applications"},"calculatedCurrencies":null,"additionalProperties":{"customerRefValue10":"F0011125658"}}],"links":{"next":"/v2/transactions?limit=2&offset=4","count":"/v2/transactions/count"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/transactions/count": { "get": { "tags": [ "Transactions" ], "summary": "Get count of transactions of a company", "operationId": "V2TransactionsGetTransactionsCount", "parameters": [ { "name": "PaymentMethodType", "in": "query", "description": "Filter by payment method type", "schema": { "enum": [ "DebitCard", "CreditCard", "Prepaid", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" } }, { "name": "Status", "in": "query", "description": "Filter by transaction status", "schema": { "type": "array", "items": { "enum": [ "Failed", "Pending", "Reversed", "Completed", "Refunded" ], "type": "string" } } }, { "name": "FromTransactionDate", "in": "query", "description": "Filter transactions from this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "ToTransactionDate", "in": "query", "description": "Filter transactions to this date (YYYY-MM-DD)", "schema": { "type": "string", "format": "date-time" } }, { "name": "MatchStatus", "in": "query", "description": "Filter by transaction match statuses", "schema": { "type": "array", "items": { "enum": [ "None", "MatchFound", "Confirmed" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":20},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/trips": { "get": { "tags": [ "Trips" ], "summary": "Get the trips of the company", "operationId": "V2TripsGetTrips", "parameters": [ { "name": "userId", "in": "query", "description": "The unique identifier of a user", "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of trips to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of trips to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list (options: name)", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "description": "Filter on active trips (default is all trips)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on the trips where the name, reference or a destination contains this string, or where the id matches it", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter on status of trips (default is all states)", "schema": { "type": "array", "items": { "enum": [ "Created", "ToSubmit", "Submitted", "Approved", "Rejected", "Completed", "Controlled", "Recalled" ], "type": "string" } } }, { "name": "fromDate", "in": "query", "description": "Filter trips where the end date is on or after this date", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "description": "Filter trips where the start date is on or before this date", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_TripSummary" }, "example": {"data":[{"id":"81a8e581-7c25-4129-8526-40cb19186cae","userId":"9ca4c26e-9458-422c-b53b-5e9237702605","name":"trip_129","refId":"ref_229","isActive":true,"startDate":"2026-11-02T14:19:47.8716728+01:00","endDate":"2026-10-28T14:19:47.8716728+01:00","status":"Created"},{"id":"3ca2d42c-96da-41da-b58a-e25b361f90a5","userId":"1bfa616a-e4f7-4ae3-a495-264d1b1910a3","name":"trip_44","refId":"ref_212","isActive":true,"startDate":"2026-11-02T14:19:47.8716771+01:00","endDate":"2026-10-28T14:19:47.8716771+01:00","status":"Created"}],"links":{"next":"/v2/trips?userId=87fdb72f-cb2e-460b-89f1-43cc64e91736&limit=5&offset=6&isActive=true&status=Created","count":"/v2/trips/count?userId=08fdd010-82dc-42e7-82b5-819e765e2f00&isActive=true&status=Created"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/trips/count": { "get": { "tags": [ "Trips" ], "summary": "Get the total number of trips", "operationId": "V2TripsGetCount", "parameters": [ { "name": "userId", "in": "query", "description": "The unique identifier of a user", "schema": { "type": "string", "format": "uuid" } }, { "name": "isActive", "in": "query", "description": "Filter on active trips (default is all trips)", "schema": { "type": "boolean" } }, { "name": "search", "in": "query", "description": "Filter on trips where the name, reference or a destination contains this string, or where the id matches it", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter on status of trips (default is all states)", "schema": { "type": "array", "items": { "enum": [ "Created", "ToSubmit", "Submitted", "Approved", "Rejected", "Completed", "Controlled", "Recalled" ], "type": "string" } } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/trips/{tripId}": { "get": { "tags": [ "Trips" ], "summary": "Get the specified trip", "operationId": "V2TripsGetTrip", "parameters": [ { "name": "tripId", "in": "path", "description": "The unique identifier of the trip", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserTrip" }, "example": {"data":{"id":"b188625c-e7c0-4bb0-8b61-1e81426b29b2","userId":"458b331e-2028-49bf-9ce0-8fb9d52a9042","name":"trip_92","comment":"great trip","isActive":false,"refId":"ref_92","status":"Created","destinations":[{"id":"9a0532db-44bb-4086-a470-c6d6538b214f","date":"2026-11-02T14:19:47.8920583+01:00","name":null,"location":{"lat":50.0,"lng":44.0}}],"customFields":[{"id":"5b750a33-5bea-4408-9369-1435ea1919e9","code":"codecf_51","name":"name_10","value":null,"valueId":null,"ignoreIfNotFound":false}],"attachments":null},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Trips" ], "summary": "Update the specified trip", "operationId": "V2TripsEditTrip", "parameters": [ { "name": "tripId", "in": "path", "description": "The unique identifier of the trip", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The updated trip information", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserTripUpdating" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserTripUpdating" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserTripUpdating" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserTripUpdating" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserTrip" }, "example": {"data":{"id":"9dd523c5-1eff-4989-afb7-b5ea8a5ee583","userId":"1dd602ed-eda9-452c-a78e-904016689945","name":"trip_197","comment":"great trip","isActive":false,"refId":"ref_197","status":"Created","destinations":[{"id":"8f603258-ce5c-4632-a547-8b92ec3e86d1","date":"2026-11-02T14:19:47.8971559+01:00","name":null,"location":{"lat":50.0,"lng":44.0}}],"customFields":[{"id":"bd5c5443-a36a-41ac-acc7-2a36e3bced82","code":"codecf_67","name":"name_84","value":null,"valueId":null,"ignoreIfNotFound":false}],"attachments":null},"messages":[{"code":0,"message":"trip successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "patch": { "tags": [ "Trips" ], "summary": "Patch the specified trip", "operationId": "V2TripsPatchEditTrip", "parameters": [ { "name": "tripId", "in": "path", "description": "The unique identifier of the trip", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The updated trip information", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserTrip" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Trips" ], "summary": "Delete the specified trip", "operationId": "V2TripsDeleteTrip", "parameters": [ { "name": "tripId", "in": "path", "description": "The unique identifier of the trip", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"messages":[{"code":0,"message":"trip successfully deleted"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/trips": { "post": { "tags": [ "Trips" ], "summary": "Add a trip for the specified user", "operationId": "V2TripsAddTrip", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of a user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The trip information to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserTripAdding" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserTripAdding" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserTripAdding" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserTripAdding" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserTrip" }, "example": {"data":{"id":"76ee381d-970f-431b-a1c5-bbe2509bb134","userId":"6d616fee-e046-4124-83ab-7bb41c562e22","name":"trip_29","comment":"great trip","isActive":false,"refId":"ref_29","status":"Created","destinations":[{"id":"50cf8cec-8a1a-4c33-8178-7be3de78fcfc","date":"2026-11-02T14:19:47.9068441+01:00","name":null,"location":{"lat":50.0,"lng":44.0}}],"customFields":[{"id":"2e71cb26-83cf-4c4f-a53c-1361a277c305","code":"codecf_38","name":"name_203","value":null,"valueId":null,"ignoreIfNotFound":false}],"attachments":null},"messages":[{"code":0,"message":"trip successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/trips/changestatus": { "post": { "tags": [ "Trips" ], "summary": "Change the status of a set of trips to a specific status", "operationId": "V2TripsChangeStatusForTrips", "requestBody": { "description": "The target status and the trips to change", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ChangeTripStatus" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ChangeTripStatus" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeTripStatus" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ChangeTripStatus" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"messages":[{"code":0,"message":"Trip statuses successfully changed."}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/linkedaccounts": { "get": { "tags": [ "UserLinkedAccounts" ], "summary": "Get a list of linked accounts for a user", "operationId": "V2UserLinkedAccountsGetPermissions", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "description": "The number of linked accounts to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of linked accounts to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_LinkedAccountsUser" }, "example": {"data":[{"linkedAccountUserId":"050658ae-e115-43ee-aae2-4c4e135a2363","roles":["Admin","Personal"],"permissions":["AccessPersonalTransactions"]},{"linkedAccountUserId":"d215fc8b-cd0a-44c0-a310-29a373c25a2f","roles":["Personal"],"permissions":["AccessPersonalTransactions"]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "post": { "tags": [ "UserLinkedAccounts" ], "summary": "Create a linked account connection", "operationId": "V2UserLinkedAccountsPostLinkedAccounts", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The linked account where the user needs access to", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateUserLinkedAccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateUserLinkedAccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateUserLinkedAccount" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreateUserLinkedAccount" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_LinkedAccountsUser" }, "example": {"data":[{"linkedAccountUserId":"5fa104b1-94c7-448f-bcb2-6037747f99ff","roles":["Admin","Personal"],"permissions":["AccessPersonalTransactions"]},{"linkedAccountUserId":"351f6cf1-6140-488a-90f5-6b92a6d7b84d","roles":["Personal"],"permissions":["AccessPersonalTransactions"]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "UserLinkedAccounts" ], "summary": "Edit a linked account connection", "operationId": "V2UserLinkedAccountsPutLinkedAccounts", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The linked account where the user needs access to", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateUserLinkedAccount" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateUserLinkedAccount" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateUserLinkedAccount" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateUserLinkedAccount" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_LinkedAccountsUser" }, "example": {"data":[{"linkedAccountUserId":"b7a50e9b-b6d2-48d5-ba97-f195487cc9ad","roles":["Admin","Personal"],"permissions":["AccessPersonalTransactions"]},{"linkedAccountUserId":"9bf140f3-61c7-46ff-a9d9-0b12f2b84cee","roles":["Personal"],"permissions":["AccessPersonalTransactions"]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "UserLinkedAccounts" ], "summary": "Delete a linked account connection", "operationId": "V2UserLinkedAccountsDeleteLinkedAccounts", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The linked accounts thats needs to be deleted", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"messages":[{"code":0,"message":"linked accounts are successfully deleted"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/linkedaccounts/count": { "get": { "tags": [ "UserLinkedAccounts" ], "summary": "Get the number of linked accounts for a user", "operationId": "V2UserLinkedAccountsGetCount", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of a user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Counts" }, "example": {"data":{"count":2},"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/expenseapprovers": { "put": { "tags": [ "Users" ], "summary": "Edit expense approver assignments for user", "operationId": "V2UserApproversAssignUserApprovers", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the approver assignments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserApprovers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserApprovers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserApprovers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserApprovers" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserApprovers_And_RoleAssignmentResult_And_RoleAssignmentResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/expenseapprovers": { "get": { "tags": [ "Users" ], "summary": "Returns expense approver assignments for the user", "operationId": "V2UserApproversGetUserApprovers", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserApprovers" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/travelapprovers": { "get": { "tags": [ "Users" ], "summary": "Returns travel approver assignments for the user", "operationId": "V2UserApproversGetTravelUserApprovers", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Edit travel approver assignments for user", "operationId": "V2UserApproversAssignTravelUserApprovers", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the approver assignments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/TravelUserApprovers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TravelUserApprovers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TravelUserApprovers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TravelUserApprovers" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users": { "post": { "tags": [ "Users" ], "summary": "Add a user to the company", "operationId": "V2UserAddUser", "requestBody": { "description": "The information of the user to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddCommonUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddCommonUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddCommonUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddCommonUser" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonUser" }, "example": {"data":{"id":"3b48bc4a-05c6-46e1-8f90-86205dcab6ac","enabled":true,"email":"jimmy.page@rydoo.com","firstName":"Jimmy","lastName":"Page","refId":"EUS845","authentication":"Password","country":"FRA","languageCountryCode":"fr-FR","accountNumber":"FR56 7565 5657 2651","commuterTraffic":{"distance":50.0,"unit":"Kilometer"},"customFields":[{"key":"Guitar","value":"Fender Telecaster","valueCode":"01"}]},"messages":[{"code":0,"message":"user is successfully added"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Users" ], "summary": "Search for user", "operationId": "V2UserSearchUser", "parameters": [ { "name": "search", "in": "query", "description": "Search string", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "User's email", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "description": "User's first name", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "description": "User's last name", "schema": { "type": "string" } }, { "name": "hasCard", "in": "query", "description": "User's with/without card module", "schema": { "type": "boolean" } }, { "name": "externalId", "in": "query", "description": "User's ExternalId", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "The number of users to get (used for paging)", "schema": { "type": "integer", "format": "int32", "default": 50 } }, { "name": "offset", "in": "query", "description": "The number of users to skip (used for paging)", "schema": { "type": "integer", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_CommonUserSummary" }, "example": {"data":[{"email":"John_70+Smith_138@testdomain.com","firstName":"John_70","lastName":"Smith_138","id":"108a4746-2744-43c9-9584-11dcff7295de","enabled":true},{"email":"John_141+Smith_58@testdomain.com","firstName":"John_141","lastName":"Smith_58","id":"d13a9a8d-d9c3-46d6-bd67-246e794af864","enabled":true}],"links":{"next":"/v2/users?email=smith&limit=2&offset=2"}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}": { "put": { "tags": [ "Users" ], "summary": "Update the user", "operationId": "V2UserUpdateUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the user with", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/EditCommonUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EditCommonUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EditCommonUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/EditCommonUser" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonUser" }, "example": {"data":{"id":"53664c78-4f82-4131-bee8-1773be27dfbd","enabled":true,"email":"jimmy.page@rydoo.com","firstName":"Jimmy","lastName":"Page","refId":"EUS845","authentication":"Password","country":"FRA","languageCountryCode":"fr-FR","accountNumber":"FR56 7565 5657 2651","commuterTraffic":{"distance":50.0,"unit":"Kilometer"},"customFields":[{"key":"Guitar","value":"Fender Telecaster","valueCode":"01"}]},"messages":[{"code":0,"message":"user successfully edited"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "get": { "tags": [ "Users" ], "summary": "Get a specific user", "operationId": "V2UserGetUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user. This response contains all the details of the user.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_ExistingCommonUser" }, "example": {"data":{"id":"a3e0a511-e178-42e3-b075-b7bf98a1745a","enabled":true,"email":"jimmy.page@rydoo.com","firstName":"Jimmy","lastName":"Page","refId":"EUS845","authentication":"Password","country":"FRA","languageCountryCode":"fr-FR","accountNumber":"FR56 7565 5657 2651","commuterTraffic":{"distance":50.0,"unit":"Kilometer"},"customFields":[{"key":"Guitar","value":"Fender Telecaster","valueCode":"01"}]},"messages":[{"code":0,"message":""}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/expensecontrollers": { "get": { "tags": [ "Users" ], "summary": "Returns controller assignments for the user", "operationId": "V2UserControllersGetUserApprovers", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserControllers" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Edit controller assigments for user", "operationId": "V2UserControllersAssignUserApprovers", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information to update the controller assignments", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserControllers" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserControllers" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserControllers" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserControllers" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_UserControllers_And_RoleAssignmentResult_And_RoleAssignmentResult" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/groups": { "get": { "tags": [ "Users" ], "summary": "Get the groups to which the user belongs", "operationId": "V2UserGroupGetGroupsForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_UserGroupAssignment" }, "example": {"data":[{"group":{"branch":{"id":"2fb230bf-6364-470f-ab87-acdf56bd7b00","name":"branch_191","refId":"ref_191"},"id":"412f846e-d9b1-45bf-9e8c-ae1d0ea613a5","name":"gr_110","refId":"grref_110"},"startDate":"2026-11-02","endDate":null}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Update the groups to which the user belongs", "operationId": "V2UserGroupUpdateGroupsForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The information describing to which the groups the user belongs", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAssignmentChange" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAssignmentChange" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAssignmentChange" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAssignmentChange" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_UserGroupAssignment" }, "example": {"messages":[{"code":0,"message":"group assignments succesfully updated"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/paymentmethods": { "get": { "tags": [ "Users" ], "summary": "Get the payment methods for the user", "operationId": "V2UserPaymentMethodsGetPaymentMethodsForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "isActive", "in": "query", "description": "Filter on active payment methods (default is all payment methods)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_UserPaymentMethod" }, "example": {"data":[{"id":"f86839d2-470d-4b4e-b91c-54e4f3581d17","name":"payment_210","isActive":false,"cardNumber":"515157","accountNumber":null,"accountType":"CreditCard","accountOwnership":0}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/paymentmethods/tobeclaimed": { "get": { "tags": [ "Users" ], "summary": "Get the payment methods which can be claimed", "operationId": "V2UserPaymentMethodsGetPaymentMethodsToBeClaimed", "parameters": [ { "name": "limit", "in": "query", "description": "The number of payment methods to get (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "offset", "in": "query", "description": "The number of payment methods to skip (used for paging)", "schema": { "type": "integer", "format": "int32" } }, { "name": "sort", "in": "query", "description": "Determines on what to sort the list", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_PaymentMethodToBeClaimed" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/roles": { "get": { "tags": [ "Users" ], "summary": "Get the roles of the user", "operationId": "V2UserRolesGetRoleAssignmentsForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_UserRoleAssignment" }, "example": {"data":[{"roleType":"Approver","role":{"id":"625c9f36-d925-41c0-961a-f86d995189b9","name":"role_625c9f36-d925-41c0-961a-f86d995189b9","refId":"ref625c9f36-d925-41c0-961a-f86d995189b9"},"groups":null,"projects":null,"users":null,"branches":[{"id":"f39aab0e-c0d5-4add-8ca1-b078d5481872","name":"branch_14","refId":"ref_14"}]}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Update the roles of the user", "operationId": "V2UserRolesUpdateRoleAssignmentsForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The roles of the user to update with", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignmentChange" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignmentChange" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignmentChange" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignmentChange" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_UserRoleAssignment" }, "example": {"messages":[{"code":0,"message":"role assignments succesfully updated"}],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{id}/extendedroles": { "get": { "tags": [ "Users" ], "summary": "Get the extended roles of the user", "operationId": "V2UserRolesGetExtendedRolesForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_Array_Of_ExtendedRoleAssigment" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Update the extended roles of the user", "operationId": "V2UserRolesUpdateExtendedRolesForUser", "parameters": [ { "name": "id", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The extended roles of the user to update with", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedRoleAssigmentChange" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedRoleAssigmentChange" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedRoleAssigmentChange" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedRoleAssigmentChange" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/user-role-assignments": { "get": { "tags": [ "Users" ], "summary": "Get role assignments for a user", "operationId": "V2UserRolesGetUserRoleAssignments", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Add role assignments for a user", "operationId": "V2UserRolesAddRoleAssignment", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "The role assignment to add", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AddRoleAssignmentRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AddRoleAssignmentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddRoleAssignmentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AddRoleAssignmentRequest" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/user-role-assignments/{role}/branches": { "patch": { "tags": [ "Users" ], "summary": "Update branches for a user’s role assignment", "operationId": "V2UserRolesUpdateUserRoleBranches", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role", "in": "path", "description": "The role to update branches for", "required": true, "schema": { "enum": [ "Finance", "Director", "Treasurer", "Analyst", "Administrator", "BranchManager", "ApiManager", "Approver", "Controller", "User" ], "type": "string" } } ], "requestBody": { "description": "The branches to update", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/UserPermissionBranchesChangeRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPermissionBranchesChangeRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPermissionBranchesChangeRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserPermissionBranchesChangeRequest" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/user-role-assignments/{role}": { "delete": { "tags": [ "Users" ], "summary": "Remove role assignments for a user", "operationId": "V2UserRolesRemoveRoleAssignment", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role", "in": "path", "description": "The role assignment to remove", "required": true, "schema": { "enum": [ "Finance", "Director", "Treasurer", "Analyst", "Administrator", "BranchManager", "ApiManager", "Approver", "Controller", "User" ], "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/users/{userId}/user-role-assignments/{role}/permissions": { "get": { "tags": [ "Users" ], "summary": "Get the permission of a user for a given role", "operationId": "V2UserRolesGetTreasurerPermissions", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role", "in": "path", "description": "The role to read permissions for. Only Treasurer is supported.", "required": true, "schema": { "enum": [ "Finance", "Director", "Treasurer", "Analyst", "Administrator", "BranchManager", "ApiManager", "Approver", "Controller", "User" ], "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "put": { "tags": [ "Users" ], "summary": "Set the permission of a user for a given role", "operationId": "V2UserRolesSetTreasurerPermission", "parameters": [ { "name": "userId", "in": "path", "description": "The unique identifier of the user", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "role", "in": "path", "description": "The role to set permissions for. Only Treasurer is supported.", "required": true, "schema": { "enum": [ "Finance", "Director", "Treasurer", "Analyst", "Administrator", "BranchManager", "ApiManager", "Approver", "Controller", "User" ], "type": "string" } } ], "requestBody": { "description": "The permission to assign", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/SetTreasurerPermissionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SetTreasurerPermissionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SetTreasurerPermissionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SetTreasurerPermissionRequest" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/progress": { "get": { "tags": [ "Widgets" ], "summary": "Get the progress of company account setup", "operationId": "V2WidgetsGetCompanyProgress", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AccountTracker" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } }, "delete": { "tags": [ "Widgets" ], "summary": "Hide the progress of company account setup", "operationId": "V2WidgetsHideCompanyProgress", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_AccountTracker" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/yourexpenses": { "get": { "tags": [ "Widgets" ], "summary": "Get the total ammount of a group of your expenses", "operationId": "V2WidgetsGetYourExpenses", "parameters": [ { "name": "groupBy", "in": "query", "schema": { "enum": [ "Status", "Project", "Category", "PaymentMethod" ], "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "endDate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 10 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiResult_Of_YourExpenses" }, "example": {"data":[],"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/companymessage": { "get": { "tags": [ "Widgets" ], "summary": "Get the message for the Company", "operationId": "V2WidgetsGetCompanyMessage", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_CompanyMessage" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/companymessage/show": { "post": { "tags": [ "Widgets" ], "summary": "Get the message for the Company", "operationId": "V2WidgetsCompanyMessageShow", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/companymessage/hide": { "post": { "tags": [ "Widgets" ], "summary": "Get the message for the Company", "operationId": "V2WidgetsCompanyMessageHide", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Result" }, "example": {"links":{}} } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/myexpenses": { "get": { "tags": [ "Widgets" ], "summary": "Get the total amount of my expenses", "operationId": "V2WidgetsGetMyExpenses", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_MyExpenses" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } }, "/v2/widgets/todo": { "get": { "tags": [ "Widgets" ], "summary": "Gets the todo counts for dashboard", "operationId": "V2WidgetsGetTodoCounts", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleResult_Of_TodoCounts" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" } } } } }, "components": { "schemas": { "AccountTracker": { "type": "object", "properties": { "hideCategories": { "type": "boolean" }, "hasCategories": { "type": "boolean" }, "hasCompanyLogo": { "type": "boolean" }, "companyInfoComplete": { "type": "boolean" }, "hasUsers": { "type": "boolean" } }, "additionalProperties": false }, "ActivityExtendedResponse": { "type": "object", "properties": { "action": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "Unreadable", "ReadyForPreApproval", "ToSubmit", "ToVerify", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "PreApproved", "ReceiptUpdated", "Reimbursed", "AutoMatched", "ManuallyMatched", "SkippedOcr", "ManualChanged", "CfdiValidating", "CfdiValidated", "CfdiFailed", "CfdiInvalid", "MissingReceiptDeclarationCreated", "MissingReceiptDeclarationUpdated", "MissingReceiptDeclarationDeleted", "Unreported", "Unapproved", "Uncontrolled", "AutoApproved", "AutoControlled" ], "type": "string", "description": "The historical action of the activity." }, "timestamp": { "type": "string", "description": "The timestamp of the activity.", "format": "date-time" }, "user": { "$ref": "#/components/schemas/UserExtendedResponse" }, "authenticatedUser": { "$ref": "#/components/schemas/UserExtendedResponse" }, "role": { "enum": [ "Personal", "Approver", "Controller", "Director", "Finance" ], "type": "string", "description": "The role of the expense user owner.", "nullable": true }, "rejectReason": { "$ref": "#/components/schemas/RejectReasonExtendedResponse" } }, "additionalProperties": false, "description": "Represents a historical past activity within the expense." }, "AddCommonUser": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Status of the user. When you set the status to true, this user receives an automated email to verify her / his account. When value is not provided user will be inactive by default." }, "groupId": { "type": "string", "description": "Group assigned to this user. Not supported for all companies.", "format": "uuid", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "Email of the user. Email should be unique for the company account.", "nullable": true }, "firstName": { "maxLength": 50, "type": "string", "description": "First name of the user", "nullable": true }, "lastName": { "maxLength": 60, "type": "string", "description": "Last name of the user", "nullable": true }, "refId": { "maxLength": 36, "type": "string", "description": "Reference identifier of the user. Often used for employee number or vendor number in the ERP system.", "nullable": true }, "authentication": { "enum": [ "Unknown", "Password", "Sso" ], "type": "string", "description": "Authentication type of the user. Possible values are password and sso. When value is not provided, by default user will have authorization taken from company settings.", "nullable": true }, "country": { "maxLength": 3, "type": "string", "description": "Country of the user represented by the 3-letter country code (ISO 3166). \r\nExamples: FRA, POL", "nullable": true }, "languageCountryCode": { "maxLength": 5, "type": "string", "description": "Language of the user is represented by ISO 639. Rydoo supports following languages:\r\nen-US, nl-BE, fr-FR, pt-BR, de-DE, es-ES, it-IT, da-DK, hu-HU, cs-CZ, pl-PL, sk-SK, zh-CN, ja-JP, fi-FI, sv-SE", "nullable": true }, "accountNumber": { "type": "string", "description": "Direct deposit account of the user where they want to receive their reimbursement of expenses. This is not mandatory and mostly handled within ERP of the company.", "nullable": true }, "commuterTraffic": { "$ref": "#/components/schemas/CommuterTraffic" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "description": "Optional custom field on user level. You can indicate multiple custom fields for one specific user.\r\nkey: to indicate the name of the custom field \r\nvalue: to indicate the value of the custom field\r\nvalueCode: to indicate a specific value code for the custom field value", "nullable": true } }, "additionalProperties": false }, "AddExpenseRequest": { "type": "object", "properties": { "userId": { "type": "string", "description": "The user id of the expense owner", "format": "uuid" }, "amount": { "type": "number", "description": "The amount set on the expense", "format": "double", "nullable": true }, "currencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "The currency of the expense. ISO 4217 three letter code", "nullable": true }, "expenseDate": { "type": "string", "description": "The date of the expense", "format": "date-time", "nullable": true }, "groupId": { "type": "string", "description": "The id of the group set on expense", "format": "uuid", "nullable": true }, "categoryId": { "type": "string", "description": "The id of the category set on expense", "format": "uuid", "nullable": true }, "projectId": { "type": "string", "description": "The id of the project set on expense", "format": "uuid", "nullable": true }, "countryCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "The country code as ISO 3166-1 alpha-3 code", "nullable": true }, "merchantName": { "maxLength": 512, "type": "string", "description": "The name of the merchant set on expense", "nullable": true }, "comment": { "maxLength": 2000, "type": "string", "description": "The comment set on expense", "nullable": true }, "paymentMethodId": { "type": "string", "description": "The id of the payment method set on expense", "format": "uuid", "nullable": true }, "tripId": { "type": "string", "description": "The id of the trip set on expense", "format": "uuid", "nullable": true }, "receiptId": { "type": "string", "description": "The id of the receipt image or attachment", "format": "uuid", "nullable": true }, "customFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRequest" }, "description": "The collection of custom field values of expense", "nullable": true }, "customExchangeRates": { "type": "array", "items": { "$ref": "#/components/schemas/CustomExchangeRateRequest" }, "description": "The collection of custom exchange rates of the expense", "nullable": true } }, "additionalProperties": false, "description": "The model to add regular expense" }, "AddExpenseResponse": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AddOrRemoveBranch": { "type": "object", "properties": { "toAdd": { "type": "array", "items": { "$ref": "#/components/schemas/BranchAssignment" }, "nullable": true }, "toRemove": { "type": "array", "items": { "$ref": "#/components/schemas/BranchAssignment" }, "nullable": true } }, "additionalProperties": false }, "AddOrRemoveGroup": { "type": "object", "properties": { "toAdd": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAssignment" }, "nullable": true }, "toRemove": { "type": "array", "items": { "$ref": "#/components/schemas/GroupAssignment" }, "nullable": true } }, "additionalProperties": false }, "AddOrRemoveProject": { "type": "object", "properties": { "toAdd": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectAssignment" }, "nullable": true }, "toRemove": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectAssignment" }, "nullable": true } }, "additionalProperties": false }, "AddOrRemoveUsers": { "type": "object", "properties": { "toAdd": { "type": "array", "items": { "$ref": "#/components/schemas/UserId" }, "nullable": true }, "toRemove": { "type": "array", "items": { "$ref": "#/components/schemas/UserId" }, "nullable": true } }, "additionalProperties": false }, "AddPaymentMethod": { "required": [ "accountOwnership", "cardName", "paymentMethodType", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/PaymentMethodUser" }, "paymentMethodType": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string", "description": "Type of the payment method" }, "accountOwnership": { "enum": [ "Personal", "Company" ], "type": "string", "description": "Whether the payment method is reimbursable (Personal) or not (Company)." }, "accountNumber": { "type": "string", "description": "Complete account number. This is required only for Paypal and Cheque payment methods.", "nullable": true }, "travellerId": { "type": "string", "description": "Identifier of person using the card, used for lodge cards", "nullable": true }, "cardName": { "type": "string", "description": "Unique (within the user) name of the card" }, "cardNumber": { "type": "string", "description": "Full number of the card. Both formats, with dashes (e.g. 5555-5555-5555-4444) or without dashes (e.g. 5555555555554444), are acceptable.", "nullable": true }, "isDefault": { "type": "boolean", "description": "Whether the payment method is pre-filled in expenses. Only one payment method can be default" }, "isActive": { "type": "boolean", "description": "Whether the payment method is active or not" }, "accountingPaymentMethod": { "$ref": "#/components/schemas/BankAccount" }, "isAutoCreateExpenseEnabled": { "type": "boolean", "description": "Whether expenses should be automatically created out of transactions received for this payment method. In order to use this, auto create should be first enabled on company level. Please contact connect@rydoo.com." }, "encryptedCardNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AddRoleAssignmentRequest": { "required": [ "role" ], "type": "object", "properties": { "role": { "enum": [ "Finance", "Director", "Treasurer", "Analyst", "Administrator", "BranchManager", "ApiManager", "Approver", "Controller", "User" ], "type": "string" }, "isOnCompanyLevel": { "type": "boolean" } }, "additionalProperties": false }, "AddTransaction": { "type": "object", "properties": { "processorId": { "type": "string", "description": "The Id generated by the Bank indicating the ProcessorId", "nullable": true }, "uniqueId": { "type": "string", "description": "The UniqueId of that transaction", "nullable": true }, "userId": { "type": "string", "description": "The Id of the User which will own the transaction", "format": "uuid" }, "originalCurrencyCode": { "type": "string", "description": "The 3 letter code of the Xpenditure.ApiModel.V2.AddTransaction.OriginalAmount Currency", "nullable": true }, "originalAmount": { "type": "number", "description": "The Original Currency Amount", "format": "double" }, "billedCurrencyCode": { "type": "string", "description": "The 3 letter code of the Xpenditure.ApiModel.V2.AddTransaction.BilledAmount Currency", "nullable": true }, "billedAmount": { "type": "number", "description": "The Billed Currency Amount", "format": "double" }, "paymentMethodId": { "type": "string", "description": "The payment method which the transaction belongs to", "format": "uuid" }, "transactionDate": { "type": "string", "description": "The date in which the transaction occur", "format": "date-time" }, "country": { "type": "string", "description": "The country in which the transaction occurred", "nullable": true }, "location": { "type": "string", "description": "The location in which the transaction occurred", "nullable": true }, "city": { "type": "string", "description": "The city in which the transaction occurred", "nullable": true }, "merchantName": { "maxLength": 100, "type": "string", "description": "The transaction's origin seller name.", "nullable": true }, "merchantCategoryCode": { "type": "string", "description": "A four digit identifier that tells to which Category the Merchant from the transaction belongs.", "nullable": true } }, "additionalProperties": false }, "AdvanceExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date-time" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdvanceExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The advance unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the advance.", "nullable": true } }, "additionalProperties": false, "description": "Represents the cash advance associated to the expense." }, "AdvanceRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdvanceResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the advance", "format": "uuid" }, "name": { "type": "string", "description": "The name of the advance", "nullable": true } }, "additionalProperties": false, "description": "The model of an advance" }, "AmountResponse": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "appName": { "type": "string", "nullable": true }, "areRefreshTokensAllowed": { "type": "boolean" }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "contactEmail": { "type": "string", "nullable": true }, "flowType": { "enum": [ "AuthorizationCode", "ClientCredentials" ], "type": "string" }, "postLogoutRedirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "isEnabled": { "type": "boolean" }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time", "nullable": true }, "scopeList": { "type": "array", "items": { "$ref": "#/components/schemas/ScopesModel" }, "nullable": true } }, "additionalProperties": false }, "AppOverview": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "appName": { "type": "string", "nullable": true }, "flowType": { "enum": [ "Unknown", "AuthorizationCode", "Implicit", "Hybrid", "ClientCredentials", "ResourceOwner", "Custom", "AuthorizationCodeWithProofKey", "HybridWithProofKey" ], "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ApproverAssignment": { "type": "object", "properties": { "approvers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "conflictApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "ApproverAssignmentChange": { "type": "object", "properties": { "approvers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "conflictApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "ApproverBranchesResponse": { "type": "object", "properties": { "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchModel" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ApproverCustomFieldValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproverCustomFieldValuesResponse": { "type": "object", "properties": { "customFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/ApproverCustomFieldValue" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ApproverGroupsResponse": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupModel" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ApproverProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproverProjectsResponse": { "type": "object", "properties": { "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ApproverProject" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ApproverResult": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "isConflictApprover": { "type": "boolean" } }, "additionalProperties": false }, "ApproverUser": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ApproverUsersResponse": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/ApproverUser" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "AssignmentCustomFieldValue": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignmentGroup": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AssignmentProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "AttendeeExtendedResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "The unique identifier of the attendee user", "format": "uuid" }, "type": { "enum": [ "Internal", "External" ], "type": "string", "description": "The type of the attendee. E.g.: internal, external, etc." }, "startsAt": { "type": "integer", "description": "Zero-based index of @ character in comment before the attendee", "format": "int32" }, "length": { "type": "integer", "description": "The length of attendee in comment including @ character", "format": "int32" }, "email": { "type": "string", "description": "The email of the attendee", "nullable": true }, "fullName": { "type": "string", "description": "The full name of the attendee", "nullable": true }, "externalOrganization": { "type": "string", "description": "The name of the organization of the external attendee", "nullable": true } }, "additionalProperties": false, "description": "Represents an attendee." }, "AttendeeResponse": { "type": "object", "properties": { "userId": { "type": "string", "description": "The UUID of the attendee user", "format": "uuid" }, "type": { "enum": [ "Internal", "External" ], "type": "string", "description": "The type of the attendee. E.g.: internal, external, etc." }, "startsAt": { "type": "integer", "description": "Zero-based index of @ character in comment before the attendee", "format": "int32" }, "length": { "type": "integer", "description": "The length of attendee in comment including @ character", "format": "int32" }, "email": { "type": "string", "description": "The email of the attendee", "nullable": true }, "fullName": { "type": "string", "description": "The full name of the attendee", "nullable": true }, "externalOrganization": { "type": "string", "description": "The name of the organization of the external attendee", "nullable": true } }, "additionalProperties": false, "description": "The response model of an attendee that identifies a mentioned user in comment" }, "BankAccount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "externalId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "fullName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Branch": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "cbe": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "mappedToIntegration": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "timeOffset": { "type": "string", "nullable": true }, "enterpriseNumber": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/BranchAddress" } }, "additionalProperties": false }, "BranchAddress": { "type": "object", "properties": { "street": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchAssignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "BranchExchangeRateRequest": { "required": [ "currencyFrom", "currencyTo" ], "type": "object", "properties": { "currencyFrom": { "maxLength": 3, "minLength": 3, "type": "string" }, "currencyTo": { "maxLength": 3, "minLength": 3, "type": "string" }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BranchExchangeRateResponse": { "type": "object", "properties": { "currencyFrom": { "type": "string", "nullable": true }, "currencyTo": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "BranchExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The branch unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the branch.", "nullable": true }, "countryCode": { "type": "string", "description": "The country code of the branch.", "nullable": true }, "currencyCode": { "type": "string", "description": "The currency code of the branch.", "nullable": true } }, "additionalProperties": false, "description": "Represents the branch associated with the expense group." }, "BranchModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the branch", "format": "uuid" }, "name": { "type": "string", "description": "The name of the branch", "nullable": true }, "countryCode": { "type": "string", "description": "The country code of the branch", "nullable": true } }, "additionalProperties": false }, "BranchSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "enterpriseNumber": { "type": "string", "nullable": true }, "currency": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BranchesApproverAssignment": { "type": "object", "properties": { "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchAssignment" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "BulkJobError": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable error code, e.g. EMPTY_EXPENSE_LIST or IDEMPOTENCY_KEY_CONFLICT", "nullable": true }, "message": { "type": "string", "nullable": true }, "index": { "type": "integer", "description": "Position of the offending item in the expenses list, when the error concerns one item", "format": "int32", "nullable": true } }, "additionalProperties": false }, "BulkJobErrorResult": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/BulkJobError" }, "nullable": true } }, "additionalProperties": false }, "BulkMultiResult_Of_ListItemUserAssignmentBulkResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignmentBulkResult" }, "nullable": true }, "totalItemsCount": { "type": "integer", "format": "int32" }, "totalItemsErrors": { "type": "integer", "format": "int32" }, "totalItemsWarnings": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "BulkMultiResult_Of_UserListItemAssignmentBulkResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserListItemAssignmentBulkResult" }, "nullable": true }, "totalItemsCount": { "type": "integer", "format": "int32" }, "totalItemsErrors": { "type": "integer", "format": "int32" }, "totalItemsWarnings": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "BusinessUnit": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CalculatedCurrency": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CashAdvance": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date-time" }, "state": { "enum": [ "Draft", "PendingApproval", "WaitingPayment", "Paid", "Rejected", "Closed" ], "type": "string" }, "cashAdvanceReceiver": { "$ref": "#/components/schemas/CashAdvanceUser" }, "project": { "$ref": "#/components/schemas/CashAdvanceProject" } }, "additionalProperties": false }, "CashAdvanceProject": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CashAdvanceUser": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Category": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "travelCategory": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "accountingNumber": { "type": "string", "nullable": true }, "secondaryAccountingNumber": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "parentCategory": { "$ref": "#/components/schemas/CategoryRef" }, "isCommentFieldRequired": { "type": "boolean" }, "defaultForExpenseTypes": { "type": "array", "items": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" }, "nullable": true }, "limitedToExpenseTypes": { "type": "array", "items": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" }, "nullable": true }, "limitedToGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true } }, "additionalProperties": false }, "CategoryChange": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "accountingNumber": { "type": "string", "nullable": true }, "secondaryAccountingNumber": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "parentCategory": { "$ref": "#/components/schemas/CategoryRef" }, "isCommentFieldRequired": { "type": "boolean" }, "defaultForExpenseTypes": { "type": "array", "items": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" }, "nullable": true }, "limitedToExpenseTypes": { "type": "array", "items": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string" }, "nullable": true }, "limitedToGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true } }, "additionalProperties": false }, "CategoryExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "number": { "type": "string", "nullable": true }, "additionalNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CategoryExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The category unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the category.", "nullable": true }, "accountingCode": { "type": "string", "description": "The accounting code of the category.", "nullable": true }, "secondaryCode": { "type": "string", "description": "The secondary code of the category.", "nullable": true } }, "additionalProperties": false, "description": "Represents the expense category." }, "CategoryRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CategoryResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the category", "format": "uuid" }, "name": { "type": "string", "description": "The name of the category", "nullable": true }, "accountingCode": { "type": "string", "description": "The accounting code of the category", "nullable": true } }, "additionalProperties": false, "description": "The model of a category" }, "CategorySummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "accountingNumber": { "type": "string", "nullable": true }, "branchId": { "type": "string", "format": "uuid" }, "branchName": { "type": "string", "nullable": true }, "hasChildren": { "type": "boolean" }, "travelCategory": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeExpenseStatus": { "type": "object", "properties": { "overridePolicies": { "type": "boolean" }, "expenseStatus": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string" }, "expenseStatusData": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseStatusData" }, "nullable": true }, "comments": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangeExpenseStatusResults": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseStatusResult" }, "nullable": true } }, "additionalProperties": false }, "ChangeTripStatus": { "type": "object", "properties": { "overridePolicies": { "type": "boolean" }, "tripStatus": { "enum": [ "Created", "ToSubmit", "Submitted", "Approved", "Rejected", "Completed", "Controlled", "Recalled" ], "type": "string" }, "tripStatusData": { "type": "array", "items": { "$ref": "#/components/schemas/TripStatusData" }, "nullable": true } }, "additionalProperties": false }, "CheckResult": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "isViolated": { "type": "boolean" } }, "additionalProperties": false }, "Client": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isEnabled": { "type": "boolean" }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "xpdApiUserId": { "type": "string", "format": "uuid", "nullable": true }, "flowType": { "enum": [ "Unknown", "AuthorizationCode", "Implicit", "Hybrid", "ClientCredentials", "ResourceOwner", "Custom", "AuthorizationCodeWithProofKey", "HybridWithProofKey" ], "type": "string" }, "hasAccessToXpdApi": { "type": "boolean" }, "hasAccessToSecurityService": { "type": "boolean" }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "postLogoutRedirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "areRefreshTokensAllowed": { "type": "boolean" } }, "additionalProperties": false }, "ClientInputModel": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "clientId": { "type": "string", "nullable": true }, "clientSecret": { "type": "string", "nullable": true }, "xpdApiUserId": { "type": "string", "format": "uuid", "nullable": true }, "flowType": { "enum": [ "Unknown", "AuthorizationCode", "Implicit", "Hybrid", "ClientCredentials", "ResourceOwner", "Custom", "AuthorizationCodeWithProofKey", "HybridWithProofKey" ], "type": "string" }, "hasAccessToXpdApi": { "type": "boolean" }, "hasAccessToSecurityService": { "type": "boolean" }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "postLogoutRedirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "areRefreshTokensAllowed": { "type": "boolean" } }, "additionalProperties": false }, "ClientOverview": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clientId": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "CommonProject": { "type": "object", "properties": { "name": { "maxLength": 512, "type": "string", "description": "Display name of the project.This value will be shown in the Rydoo app when she is making a booking or creating an expense.", "nullable": true }, "isActive": { "type": "boolean", "description": "Determines if you want to activate this project. When value is empty the project will be inactive by default." }, "refId": { "maxLength": 36, "type": "string", "description": "Reference identifier of the project. Often used for project number in the ERP system.", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "description": "Optional custom field on field level. You should provide the name of the custom field. \r\nPlease consult with your technical contact person to identify the custom field name. \r\nYou can indicate multiple custom fields for one specific field.", "nullable": true } }, "additionalProperties": false }, "CommonProjectSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "Project id generated by Rydoo and is unique identifier of the project in the Rydoo platform.", "format": "uuid" }, "name": { "type": "string", "description": "Display name of the project.This value will be shown in the Rydoo app when she is making a booking or creating an expense.", "nullable": true }, "isActive": { "type": "boolean", "description": "Determines if you want to activate this project. When value is empty the project will be inactive by default." }, "refId": { "type": "string", "description": "Reference identifier of the project. Often used for project number in the ERP system.", "nullable": true } }, "additionalProperties": false }, "CommonUserSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "modules": { "type": "array", "items": { "enum": [ "Expense", "Travel", "Card" ], "type": "string" }, "nullable": true }, "enabled": { "type": "boolean" }, "externalId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CommuterTraffic": { "type": "object", "properties": { "distance": { "type": "number", "format": "double", "nullable": true }, "unit": { "enum": [ "Unknown", "Kilometer", "Mile" ], "type": "string", "description": "The distance unit" } }, "additionalProperties": false }, "Company": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "companyId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompanyCurrencySummary": { "type": "object", "properties": { "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompanyCustomField": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "usedIn": { "type": "array", "items": { "type": "string" }, "nullable": true }, "type": { "type": "string", "nullable": true }, "required": { "type": "boolean" }, "status": { "type": "string", "nullable": true }, "limitations": { "$ref": "#/components/schemas/CustomFieldLimitations" }, "reportingFilter": { "type": "boolean" }, "readOnly": { "type": "boolean" } }, "additionalProperties": false }, "CompanyCustomFieldListItem": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "billingLegalEntityId": { "type": "string", "nullable": true }, "limitations": { "$ref": "#/components/schemas/ListItemLimitations" }, "defaultFor": { "$ref": "#/components/schemas/DefaultFor" } }, "additionalProperties": false }, "CompanyCustomFieldSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "usedIn": { "type": "array", "items": { "type": "string" }, "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompanyMessage": { "type": "object", "properties": { "imageUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "body": { "type": "string", "nullable": true }, "isHidden": { "type": "boolean" } }, "additionalProperties": false }, "ControllerAssignment": { "type": "object", "properties": { "controllers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "conflictControllers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "ControllerAssignmentChange": { "type": "object", "properties": { "controllers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "conflictControllers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "ConvertedCurrencyExpenseSummary": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "taxAmount": { "type": "number", "format": "double", "nullable": true }, "exchangeRate": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Country": { "type": "object", "properties": { "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Counts": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CreateAppRequest": { "required": [ "appName", "contactEmail", "flowType" ], "type": "object", "properties": { "appName": { "maxLength": 80, "type": "string" }, "contactEmail": { "maxLength": 80, "type": "string", "format": "email" }, "flowType": { "enum": [ "AuthorizationCode", "ClientCredentials" ], "type": "string" }, "postLogoutRedirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scopeList": { "type": "array", "items": { "$ref": "#/components/schemas/ScopesModel" }, "nullable": true } }, "additionalProperties": false }, "CreateLimitationChain": { "type": "object", "properties": { "limitations": { "type": "array", "items": { "$ref": "#/components/schemas/LimitationChainItem" }, "nullable": true } }, "additionalProperties": false }, "CreateReimbursementJobData": { "type": "object", "properties": { "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/CreateReimbursementJobExpenseData" }, "description": "The expenses to reimburse, at most 1000. Order is preserved and duplicated ids are kept as independent items.", "nullable": true } }, "additionalProperties": false, "description": "Asynchronous bulk reimbursement request. Items are processed independently; business errors are reported per item." }, "CreateReimbursementJobExpenseData": { "type": "object", "properties": { "expenseId": { "type": "string", "description": "The UUID of the expense. A missing, malformed or empty UUID rejects the request with INVALID_EXPENSE_ID.", "nullable": true }, "paymentReference": { "type": "string", "description": "Optional payment reference (at most 1000 characters), stored as submitted.", "nullable": true } }, "additionalProperties": false }, "CreateReimbursementJobResult": { "type": "object", "properties": { "jobId": { "type": "string", "description": "The UUID of the reimbursement job", "format": "uuid" }, "state": { "type": "string", "description": "ACCEPTED on creation; the current state of the job when an idempotent request is replayed", "nullable": true }, "acceptedAt": { "type": "string", "description": "When the job was durably accepted", "format": "date-time" } }, "additionalProperties": false }, "CreateUserLinkedAccount": { "type": "object", "properties": { "linkedAccountUserId": { "type": "string", "format": "uuid" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Currency": { "type": "object", "properties": { "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomExchangeRateRequest": { "type": "object", "properties": { "currencyCode": { "maxLength": 3, "minLength": 3, "type": "string", "description": "The currency code of the custom exchange rate. ISO 4217 three letter code", "nullable": true }, "customRate": { "type": "number", "description": "The custom rate of the currency", "format": "double" } }, "additionalProperties": false, "description": "The model to define a custom exchange rate for an expense" }, "CustomField": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isFilter": { "type": "boolean" }, "limitations": { "$ref": "#/components/schemas/Limitations" }, "externalId": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "enum": [ "Approver", "Controller", "Director", "CFO", "User", "BranchManager" ], "type": "string" }, "nullable": true }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "type": { "enum": [ "FreeText", "List", "Numeric" ], "type": "string" } }, "additionalProperties": false }, "CustomFieldExpenseSummary": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomFieldLimitations": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "branches": { "type": "array", "items": { "type": "string" }, "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CustomFieldListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "value": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "CustomFieldRoleCombinations": { "type": "object", "properties": { "roleCombinations": { "type": "array", "items": { "type": "array", "items": { "type": "string" } }, "nullable": true } }, "additionalProperties": false }, "CustomFieldValue": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomFieldValueAssignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "CustomFieldValueExtendedResponse": { "type": "object", "properties": { "customFieldId": { "type": "string", "description": "The UUID of the custom field", "format": "uuid" }, "customFieldName": { "type": "string", "description": "The name of the custom field", "nullable": true }, "customFieldType": { "enum": [ "Text", "List", "Numeric" ], "type": "string", "description": "The type of the custom field" }, "listItemId": { "type": "string", "description": "The UUID of the list item\r\nShould be null is custom field type is not 'list'", "format": "uuid", "nullable": true }, "listItemName": { "type": "string", "description": "The list item name\r\nShould be null is custom field type is not 'list'", "nullable": true }, "textValue": { "type": "string", "description": "The text value\r\nShould be null is custom field type is not 'text'", "nullable": true } }, "additionalProperties": false, "description": "Represents a custom field value." }, "CustomFieldValueRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "format": "uuid", "nullable": true }, "ignoreIfNotFound": { "type": "boolean" } }, "additionalProperties": false }, "CustomFieldValueRequest": { "type": "object", "properties": { "customFieldId": { "type": "string", "description": "The id of the custom field", "format": "uuid" }, "listItemId": { "type": "string", "description": "The Id of the list item of the custom field", "format": "uuid", "nullable": true }, "textValue": { "maxLength": 2000, "type": "string", "description": "The text value value set for custom field", "nullable": true } }, "additionalProperties": false, "description": "The custom field value model defining what value was set for a custom field for an expense" }, "CustomFieldValueResponse": { "type": "object", "properties": { "customFieldId": { "type": "string", "description": "The UUID of the custom field", "format": "uuid" }, "customFieldName": { "type": "string", "description": "The name of the custom field", "nullable": true }, "customFieldType": { "enum": [ "Text", "List", "Numeric" ], "type": "string", "description": "The type of the custom field" }, "listItemId": { "type": "string", "description": "The UUID of the list item\r\nShould be null is custom field type is not 'list'", "format": "uuid", "nullable": true }, "listItemName": { "type": "string", "description": "The list item name\r\nShould be null is custom field type is not 'list'", "nullable": true }, "textValue": { "type": "string", "description": "The text value\r\nShould be null is custom field type is not 'text'", "nullable": true } }, "additionalProperties": false, "description": "The model of a custom field and it's value" }, "CustomFieldValues": { "type": "object", "properties": { "toAdd": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueAssignment" }, "nullable": true }, "toRemove": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueAssignment" }, "nullable": true } }, "additionalProperties": false }, "CustomFieldValuesApproverAssignment": { "type": "object", "properties": { "customFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentCustomFieldValue" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "DeductionExtendedExpense": { "type": "object", "properties": { "id": { "type": "string", "description": "The deduction unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the deduction.", "nullable": true }, "amount": { "type": "number", "description": "The amount of the deduction.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Represents a per diem deduction." }, "DeductionResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the deduction", "format": "uuid" }, "name": { "type": "string", "description": "The name of the deduction", "nullable": true }, "amount": { "type": "number", "description": "The amount of the deduction", "format": "double" } }, "additionalProperties": false, "description": "The model of a deduction" }, "DefaultFor": { "type": "object", "properties": { "groups": { "$ref": "#/components/schemas/DefaultForGroups" } }, "additionalProperties": false }, "DefaultForGroups": { "type": "object", "properties": { "all": { "type": "boolean" }, "ids": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "EditCommonUser": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Status of the user. When you set the status to true, this user receives an automated email to verify her / his account. When value is not provided, the status remains unchanged.", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "Email of the user. Email should be unique for the company account.", "nullable": true }, "firstName": { "maxLength": 50, "type": "string", "description": "First name of the user", "nullable": true }, "lastName": { "maxLength": 60, "type": "string", "description": "Last name of the user", "nullable": true }, "refId": { "maxLength": 36, "type": "string", "description": "Reference identifier of the user. Often used for employee number or vendor number in the ERP system.", "nullable": true }, "authentication": { "enum": [ "Unknown", "Password", "Sso" ], "type": "string", "description": "Authentication type of the user. Possible values are password and sso. When value is not provided, by default user will have authorization taken from company settings.", "nullable": true }, "country": { "maxLength": 3, "type": "string", "description": "Country of the user represented by the 3-letter country code (ISO 3166). \r\nExamples: FRA, POL", "nullable": true }, "languageCountryCode": { "maxLength": 5, "type": "string", "description": "Language of the user is represented by ISO 639. Rydoo supports following languages:\r\nen-US, nl-BE, fr-FR, pt-BR, de-DE, es-ES, it-IT, da-DK, hu-HU, cs-CZ, pl-PL, sk-SK, zh-CN, ja-JP, fi-FI, sv-SE", "nullable": true }, "accountNumber": { "type": "string", "description": "Direct deposit account of the user where they want to receive their reimbursement of expenses. This is not mandatory and mostly handled within ERP of the company.", "nullable": true }, "commuterTraffic": { "$ref": "#/components/schemas/CommuterTraffic" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "description": "Optional custom field on user level. You can indicate multiple custom fields for one specific user.\r\nkey: to indicate the name of the custom field \r\nvalue: to indicate the value of the custom field\r\nvalueCode: to indicate a specific value code for the custom field value", "nullable": true } }, "additionalProperties": false }, "EditPaymentMethod": { "required": [ "accountOwnership", "cardName", "paymentMethodType", "user" ], "type": "object", "properties": { "user": { "$ref": "#/components/schemas/PaymentMethodUser" }, "paymentMethodType": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" }, "accountOwnership": { "enum": [ "Personal", "Company" ], "type": "string" }, "accountNumber": { "type": "string", "nullable": true }, "travellerId": { "type": "string", "nullable": true }, "cardName": { "type": "string" }, "cardNumber": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "cardType": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string", "nullable": true }, "accountingPaymentMethod": { "$ref": "#/components/schemas/BankAccount" }, "foreignPaymentExpenseIncreasePercentage": { "type": "number", "format": "double", "nullable": true }, "isAutoCreateExpenseEnabled": { "type": "boolean" }, "encryptedCardNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmbedConfig": { "type": "object", "properties": { "reportName": { "type": "string", "nullable": true }, "embedUrl": { "type": "string", "nullable": true }, "embedToken": { "$ref": "#/components/schemas/EmbedToken" }, "minutesToExpiration": { "type": "integer", "format": "int32", "readOnly": true }, "isEffectiveIdentityRolesRequired": { "type": "boolean", "nullable": true }, "isEffectiveIdentityRequired": { "type": "boolean", "nullable": true }, "enableRLS": { "type": "boolean" }, "username": { "type": "string", "nullable": true }, "roles": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "pageName": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Represents PowerBi report/dashboard/etc metadata\r\nContains Url and token for PowerBi entity access" }, "EmbedToken": { "type": "object", "properties": { "token": { "type": "string", "nullable": true }, "tokenId": { "type": "string", "nullable": true }, "expiration": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ErrorModel": { "type": "object", "properties": { "errorCode": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorModel" }, "description": "The collection of errors if the operation was unsuccessful", "nullable": true } }, "additionalProperties": false, "description": "The response when the operation is unsuccessful" }, "ExchangeRateExtendedResponse": { "type": "object", "properties": { "convertedAmount": { "type": "number", "description": "The converted amount in the specified currency", "format": "double" }, "currencyCode": { "type": "string", "description": "The three-letter ISO-4217 currency code", "nullable": true }, "rate": { "type": "number", "description": "The exchange rate used for the conversion", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Represents an exchange rate associated with the expense." }, "ExchangeRateResponse": { "type": "object", "properties": { "convertedAmount": { "type": "number", "description": "The converted amount in the specified currency", "format": "double" }, "currencyCode": { "type": "string", "description": "The three-letter ISO-4217 currency code", "nullable": true }, "rate": { "type": "number", "description": "The exchange rate used for the conversion", "format": "double" } }, "additionalProperties": false, "description": "The model of an exchange rate" }, "ExistingCommonProject": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 512, "type": "string", "description": "Display name of the project.This value will be shown in the Rydoo app when she is making a booking or creating an expense.", "nullable": true }, "isActive": { "type": "boolean", "description": "Determines if you want to activate this project. When value is empty the project will be inactive by default." }, "refId": { "maxLength": 36, "type": "string", "description": "Reference identifier of the project. Often used for project number in the ERP system.", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "description": "Optional custom field on field level. You should provide the name of the custom field. \r\nPlease consult with your technical contact person to identify the custom field name. \r\nYou can indicate multiple custom fields for one specific field.", "nullable": true } }, "additionalProperties": false }, "ExistingCommonUser": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" }, "email": { "maxLength": 80, "type": "string", "description": "Email of the user. Email should be unique for the company account.", "nullable": true }, "firstName": { "maxLength": 50, "type": "string", "description": "First name of the user", "nullable": true }, "lastName": { "maxLength": 60, "type": "string", "description": "Last name of the user", "nullable": true }, "refId": { "maxLength": 36, "type": "string", "description": "Reference identifier of the user. Often used for employee number or vendor number in the ERP system.", "nullable": true }, "authentication": { "enum": [ "Unknown", "Password", "Sso" ], "type": "string", "description": "Authentication type of the user. Possible values are password and sso. When value is not provided, by default user will have authorization taken from company settings.", "nullable": true }, "country": { "maxLength": 3, "type": "string", "description": "Country of the user represented by the 3-letter country code (ISO 3166). \r\nExamples: FRA, POL", "nullable": true }, "languageCountryCode": { "maxLength": 5, "type": "string", "description": "Language of the user is represented by ISO 639. Rydoo supports following languages:\r\nen-US, nl-BE, fr-FR, pt-BR, de-DE, es-ES, it-IT, da-DK, hu-HU, cs-CZ, pl-PL, sk-SK, zh-CN, ja-JP, fi-FI, sv-SE", "nullable": true }, "accountNumber": { "type": "string", "description": "Direct deposit account of the user where they want to receive their reimbursement of expenses. This is not mandatory and mostly handled within ERP of the company.", "nullable": true }, "commuterTraffic": { "$ref": "#/components/schemas/CommuterTraffic" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "description": "Optional custom field on user level. You can indicate multiple custom fields for one specific user.\r\nkey: to indicate the name of the custom field \r\nvalue: to indicate the value of the custom field\r\nvalueCode: to indicate a specific value code for the custom field value", "nullable": true } }, "additionalProperties": false }, "ExistingCompanyCustomFieldListItem": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "billingLegalEntityId": { "type": "string", "nullable": true }, "limitations": { "$ref": "#/components/schemas/ListItemLimitations" }, "defaultFor": { "$ref": "#/components/schemas/DefaultFor" } }, "additionalProperties": false }, "ExistingExternalOrganization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Expense": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an expense", "format": "uuid" }, "xpdReference": { "type": "string", "description": "A unique identifier for the expense as shown in reports", "nullable": true }, "status": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string", "description": "The status of the expense" }, "dateApproved": { "type": "string", "description": "The date on which the expense was approved", "format": "date-time", "nullable": true }, "dateControlled": { "type": "string", "description": "The date on which the expense was controlled", "format": "date-time", "nullable": true }, "group": { "$ref": "#/components/schemas/GroupRef" }, "user": { "$ref": "#/components/schemas/UserRef" }, "originalAmount": { "type": "number", "description": "The original amount of the expense (including VAT)", "format": "double", "nullable": true }, "originalCurrency": { "type": "string", "description": "The currency as shown on the original expense note", "nullable": true }, "convertedCurrencies": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseConvertedCurrency" }, "description": "The expense amount converted in different currencies", "nullable": true }, "tax": { "$ref": "#/components/schemas/ExpenseTax" }, "isInvoice": { "type": "boolean", "description": "Is the expense an invoice?" }, "invoiceNumber": { "type": "string", "description": "The invoice number, if the expense is an invoice.", "nullable": true }, "comment": { "type": "string", "description": "Description entered by the user that submitted the expense", "nullable": true }, "merchant": { "$ref": "#/components/schemas/MerchantRef" }, "country": { "type": "string", "description": "The country in which the expense was issued represented by it's ISO 3-letter code.", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectRef" }, "isReimbursable": { "type": "boolean", "description": "Is this expense reimbursable?" }, "date": { "type": "string", "description": "The date on which the expense was issued", "format": "date-time" }, "category": { "$ref": "#/components/schemas/CategoryRef" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "description": "The custom fields and values associated with the expense", "nullable": true }, "advance": { "$ref": "#/components/schemas/AdvanceRef" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "expenseType": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string", "description": "The type of expense" }, "trip": { "$ref": "#/components/schemas/TripRef" }, "mileage": { "$ref": "#/components/schemas/ExpenseMileage" }, "violatedRules": { "type": "array", "items": { "$ref": "#/components/schemas/ViolatedRule" }, "description": "The set of rules which expense doesn't satisfy", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseAttachment" }, "description": "The list of attachments associated with expense", "nullable": true }, "link": { "$ref": "#/components/schemas/ExpenseLink" } }, "additionalProperties": false }, "ExpenseAttachment": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identificator of an attachment", "format": "uuid" }, "fileName": { "type": "string", "description": "The attachment file name", "nullable": true }, "fileSizeInBytes": { "type": "integer", "description": "Size of attachment file in bytes", "format": "int32" }, "cfdiValidationStatus": { "enum": [ "Pending", "Failed", "Invalid", "Valid", "Unresponsive" ], "type": "string", "description": "If attachment is a CFDI file then this will indicate it's status. If it is not a CFDI attachment then it will be null", "nullable": true } }, "additionalProperties": false }, "ExpenseConvertedCurrency": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "taxAmount": { "type": "number", "format": "double" }, "exchangeRate": { "$ref": "#/components/schemas/ExpenseExchangeRate" } }, "additionalProperties": false }, "ExpenseDetails": { "type": "object", "properties": { "refId": { "type": "string", "nullable": true }, "amount": { "$ref": "#/components/schemas/AmountResponse" } }, "additionalProperties": false }, "ExpenseExchangeRate": { "type": "object", "properties": { "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "ExpenseGroupSummaryModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "branchId": { "type": "string", "format": "uuid", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "isMember": { "type": "boolean" }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExpenseLink": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true }, "bookingId": { "type": "string", "nullable": true }, "linkType": { "enum": [ "TravelBookingDetail" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "ExpenseMileage": { "type": "object", "properties": { "distance": { "type": "number", "format": "double" }, "distanceUnit": { "enum": [ "Unknown", "Kilometer", "Mile" ], "type": "string" }, "rate": { "$ref": "#/components/schemas/MileageRateRef" }, "numberOfOccurrences": { "type": "integer", "format": "int32" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/MileageDestination" }, "nullable": true }, "isBackAndForth": { "type": "boolean" } }, "additionalProperties": false }, "ExpenseMileageSmall": { "type": "object", "properties": { "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/MileageDestination" }, "nullable": true }, "isBackAndForth": { "type": "boolean" } }, "additionalProperties": false }, "ExpenseStatusData": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ExpenseStatusResult": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid" }, "errorCode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "ExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an expense", "format": "uuid" }, "date": { "type": "string", "description": "The date on which the expense note was issued", "format": "date-time" }, "merchantName": { "type": "string", "description": "The merchant that issued the expense", "nullable": true }, "userFullName": { "type": "string", "description": "The full name of the user that added the expense", "nullable": true }, "originalAmount": { "type": "number", "description": "The original amount of the expense (including VAT)", "format": "double", "nullable": true }, "originalCurrency": { "type": "string", "description": "The currency as shown on the original expense note", "nullable": true }, "convertedCurrencies": { "type": "array", "items": { "$ref": "#/components/schemas/ConvertedCurrencyExpenseSummary" }, "description": "The expense amount converted in different currencies", "nullable": true }, "expenseType": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string", "description": "The type of expense" }, "status": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string", "description": "The status of the expense" }, "mileage": { "$ref": "#/components/schemas/ExpenseMileageSmall" }, "perdiem": { "$ref": "#/components/schemas/PerDiem" }, "matchStatus": { "enum": [ "Default", "None", "MatchFound", "Confirmed" ], "type": "string", "description": "The expense's matching status" }, "isDateModified": { "type": "boolean", "description": "Displays that expense's date was modified" }, "isAmountModified": { "type": "boolean", "description": "Displays that expense's amount was modified" }, "isCurrencyModified": { "type": "boolean", "description": "Displays that expense's currency was modified" }, "isExchangeRateModified": { "type": "boolean", "description": "Displays that expense's exchange rate was modified" }, "hasRuleViolations": { "type": "boolean", "description": "Displays that expense has rule violations" }, "hasPotentialDuplicate": { "type": "boolean", "description": "Displays that expense has potential duplicates" }, "hasRejectHistory": { "type": "boolean", "description": "Displays expense had been rejected at least once" }, "softSplitType": { "enum": [ "Parent", "Child" ], "type": "string", "description": "Indicates whether this is a Multiple VAT (soft-split) expense.\r\n\"Parent\" for the parent expense, \"Child\" for a child expense, null for regular expenses.", "nullable": true }, "parentExpenseGuid": { "type": "string", "description": "The unique identifier of the parent expense.\r\nOnly populated for Multiple VAT child expenses; null for parent and regular expenses.", "format": "uuid", "nullable": true }, "softSplitChildrenIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The unique identifiers of the child expenses (one per tax rate).\r\nOnly populated for Multiple VAT parent expenses; null for child and regular expenses.", "nullable": true } }, "additionalProperties": false }, "ExpenseTax": { "type": "object", "properties": { "taxRate": { "$ref": "#/components/schemas/TaxRateRef" }, "amount": { "type": "number", "format": "double", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "ExpenseToBeReported": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of an expense", "format": "uuid" }, "xpdReference": { "type": "string", "description": "A unique identifier for the expense as shown in reports", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchExpenseSummary" }, "group": { "$ref": "#/components/schemas/GroupExpenseSummary" }, "user": { "$ref": "#/components/schemas/UserExpenseSummary" }, "originalAmount": { "type": "number", "description": "The original amount of the expense (including VAT)", "format": "double", "nullable": true }, "originalCurrency": { "type": "string", "description": "The currency as shown on the original expense note", "nullable": true }, "tax": { "$ref": "#/components/schemas/TaxExpenseSummary" }, "convertedCurrencies": { "type": "array", "items": { "$ref": "#/components/schemas/ConvertedCurrencyExpenseSummary" }, "description": "The expense amount converted in different currencies", "nullable": true }, "isInvoice": { "type": "boolean", "description": "Is the expense an invoice?" }, "invoiceNumber": { "type": "string", "description": "The invoice number, if the expense is an invoice.", "nullable": true }, "mileage": { "$ref": "#/components/schemas/MileageExpenseSummary" }, "comment": { "type": "string", "description": "Description entered by the user that submitted the expense", "nullable": true }, "merchant": { "$ref": "#/components/schemas/MerchantRef" }, "country": { "type": "string", "description": "The country in which the expense was issued", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectExpenseSummary" }, "isReimbursable": { "type": "boolean", "description": "Is this expense reimbursable?" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionExpenseSummary" }, "description": "Assocatied payment card transactions", "nullable": true }, "status": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string", "description": "The status of the expense" }, "date": { "type": "string", "description": "The date on which the expense was issued", "format": "date-time" }, "dateApproved": { "type": "string", "description": "The date on which the expense was approved", "format": "date-time", "nullable": true }, "dateControlled": { "type": "string", "description": "The date on which the expense was controlled", "format": "date-time", "nullable": true }, "imageUrl": { "type": "string", "description": "The url of the image associated with the expense", "nullable": true }, "category": { "$ref": "#/components/schemas/CategoryExpenseSummary" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldExpenseSummary" }, "description": "The custom fields and values associated with the expense", "nullable": true }, "advance": { "$ref": "#/components/schemas/AdvanceExpenseSummary" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodExpenseSummary" }, "expenseType": { "enum": [ "Expense", "MileageExpense", "TimeExpense", "Advance", "PurchaseOrder", "PerDiem", "CounterExpense" ], "type": "string", "description": "The type of expense" } }, "additionalProperties": false, "description": "All information associated with an expense ready to be moved to a reported state" }, "ExtendedRoleAssigment": { "type": "object", "properties": { "roleType": { "enum": [ "Administrator", "Approver", "Controller", "Director", "Finance", "SuperAdmin", "BackendAdmin", "BackendCustomerSuccess", "BackendProduct", "BackendMarketing", "BackendManagement", "BackendFinance", "BackendTranslator", "BackendBelfius", "BranchManager", "User", "Analyst", "ApiManager" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleRef" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRef" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchRef" }, "nullable": true } }, "additionalProperties": false }, "ExtendedRoleAssigmentChange": { "type": "object", "properties": { "roleType": { "enum": [ "Administrator", "Approver", "Controller", "Director", "Finance", "SuperAdmin", "BackendAdmin", "BackendCustomerSuccess", "BackendProduct", "BackendMarketing", "BackendManagement", "BackendFinance", "BackendTranslator", "BackendBelfius", "BranchManager", "User", "Analyst", "ApiManager" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleRef" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRef" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchRef" }, "nullable": true } }, "additionalProperties": false }, "ExternalAuditCheckResult": { "type": "object", "properties": { "expenseId": { "type": "string", "nullable": true }, "correlationId": { "type": "string", "nullable": true }, "checkResults": { "type": "array", "items": { "$ref": "#/components/schemas/CheckResult" }, "nullable": true } }, "additionalProperties": false }, "ExternalOrganization": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FlagsExtendedResponse": { "type": "object", "properties": { "isSplitExpense": { "type": "boolean", "description": "Value indicating whether the expense is a split expense." }, "isReimbursable": { "type": "boolean", "description": "Value indicating whether the expense is reimbursable" }, "hasAttachments": { "type": "boolean", "description": "Value indicating whether the expense has attachments." } }, "additionalProperties": false, "description": "Represents the signal flags associated with the expense." }, "FolderStateRequestModel": { "type": "object", "properties": { "folderId": { "type": "string", "format": "uuid" }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "FtpConnection": { "required": [ "filePrefix", "ftpXmlPath", "hostName", "password", "port", "userName" ], "type": "object", "properties": { "ftpConnectionGUID": { "type": "string", "format": "uuid", "nullable": true }, "isSftp": { "type": "boolean" }, "isXpenditureFtp": { "type": "boolean" }, "filePrefix": { "type": "string" }, "certificatePath": { "type": "string", "nullable": true }, "hostName": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "autoReport": { "type": "boolean" }, "ftpInboxPath": { "type": "string", "nullable": true }, "ftpImagePath": { "type": "string", "nullable": true }, "ftpXmlPath": { "type": "string" }, "certificatePassword": { "type": "string", "nullable": true }, "version": { "enum": [ "Default", "V1", "V2", "V3", "V5", "V6", "V7", "V8", "V9", "V10", "V11", "V12", "V13", "V14", "V15", "V16" ], "type": "string" }, "time": { "enum": [ "Default", "Daily", "Hourly", "Weekly", "Never" ], "type": "string" }, "onlyReportedExpenses": { "type": "boolean" }, "addBase64String": { "type": "boolean" }, "includeAdvances": { "type": "boolean" }, "keepFiles": { "type": "boolean" }, "pullHostName": { "type": "string", "nullable": true }, "pullUserName": { "type": "string", "nullable": true }, "pullPassword": { "type": "string", "nullable": true }, "ftpLogPath": { "type": "string", "nullable": true }, "isPgpEncryptionEnabled": { "type": "boolean" }, "pgpPublicKey": { "type": "string", "nullable": true }, "isPathFromRoot": { "type": "boolean" }, "rootFolder": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FtpFolder": { "required": [ "name", "state" ], "type": "object", "properties": { "name": { "maxLength": 80, "pattern": "^[a-zA-Z0-9_]*$", "type": "string" }, "id": { "type": "string", "format": "uuid", "nullable": true }, "branchCount": { "type": "integer", "format": "int32" }, "state": { "$ref": "#/components/schemas/State" } }, "additionalProperties": false }, "FtpFolderDetails": { "required": [ "name", "state" ], "type": "object", "properties": { "ftpConnection": { "$ref": "#/components/schemas/FtpConnection" }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/Branch" }, "nullable": true }, "branchCount": { "type": "integer", "format": "int32" }, "name": { "maxLength": 80, "pattern": "^[a-zA-Z0-9_]*$", "type": "string" }, "id": { "type": "string", "format": "uuid", "nullable": true }, "state": { "$ref": "#/components/schemas/State" } }, "additionalProperties": false }, "GenerateReportsModel": { "type": "object", "properties": { "reportsTypes": { "type": "array", "items": { "enum": [ "TotalExpenses", "ProcessedClaims", "ReturnedClaims", "ProcessingDaysStages", "ManagersPerApprovalStageDuration", "RateOfUncomplianceOfAllExpenses", "Top20AmountsOfSingleExpense", "Top20ClaimantsVolume", "Top20HotelExpensesBookedViaTMC", "Top20MeetingsEntertainment", "Top20MileageExpensesWoAttachments", "Top20SubsistenceExpensesOverPolicy", "MileageReport" ], "type": "string" }, "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true }, "currency": { "type": "string", "nullable": true }, "reportsMailRecipient": { "type": "string", "nullable": true }, "metric": { "type": "string", "description": "km or mi", "nullable": true } }, "additionalProperties": false }, "GeoLocationExtendedExpense": { "type": "object", "properties": { "latitude": { "type": "number", "description": "The latitude of the location.", "format": "double" }, "longitude": { "type": "number", "description": "The longitude of the location.", "format": "double" } }, "additionalProperties": false, "description": "Represents geographic coordinates associated with an expense location." }, "GetActiveBranchRatesResponse": { "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "branchExchangeRates": { "type": "array", "items": { "$ref": "#/components/schemas/BranchExchangeRateResponse" }, "nullable": true } }, "additionalProperties": false }, "GetExpenseByIdExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the expense", "format": "uuid" }, "user": { "$ref": "#/components/schemas/UserExtendedResponse" }, "xpdReference": { "type": "string", "description": "The Xpd reference of the expense", "nullable": true }, "expenseDate": { "type": "string", "description": "The date of the expense", "format": "date-time", "nullable": true }, "uploadDate": { "type": "string", "description": "The upload date of the expense.", "format": "date-time" }, "uploadSource": { "enum": [ "Upload", "Mobile", "Email", "Manual", "Dropbox", "Evernote", "Web", "Slack", "Lyft", "Uber", "AutoCreatedFromTransaction", "Invoice", "Api", "ManualFromTransaction", "Grab", "Bolt" ], "type": "string", "description": "The source of the upload.", "nullable": true }, "expenseType": { "enum": [ "Regular", "Mileage", "PerDiem", "CounterExpense" ], "type": "string", "description": "The type of the expense." }, "expenseStatus": { "enum": [ "Created", "Duplicate", "Processing", "Unreadable", "ToSubmit", "ToVerify", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Reimbursed" ], "type": "string", "description": "The status of the expense." }, "comment": { "type": "string", "description": "The comment on the expense.", "nullable": true }, "amount": { "type": "number", "description": "The amount of the expense.", "format": "double", "nullable": true }, "currencyCode": { "type": "string", "description": "The currency code of the expense.", "nullable": true }, "companyCurrencyCode": { "type": "string", "description": "The company currency code.", "nullable": true }, "group": { "$ref": "#/components/schemas/GroupExtendedResponse" }, "branch": { "$ref": "#/components/schemas/BranchExtendedResponse" }, "category": { "$ref": "#/components/schemas/CategoryExtendedResponse" }, "project": { "$ref": "#/components/schemas/ProjectExtendedResponse" }, "countryCode": { "type": "string", "description": "The country code of the expense.", "nullable": true }, "location": { "$ref": "#/components/schemas/LocationExtendedExpense" }, "trip": { "$ref": "#/components/schemas/TripExtendedExpense" }, "receipt": { "$ref": "#/components/schemas/ReceiptExtendedResponse" }, "regular": { "$ref": "#/components/schemas/RegularExpenseExtendedResponse" }, "mileage": { "$ref": "#/components/schemas/MileageExpenseExtendedResponse" }, "perDiem": { "$ref": "#/components/schemas/PerDiemExpenseExtendedResponse" }, "customFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueExtendedResponse" }, "description": "The custom field values associated with the expense.", "nullable": true }, "exchangeRates": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeRateExtendedResponse" }, "description": "The exchange rates associated with the expense.", "nullable": true }, "attendees": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeExtendedResponse" }, "description": "The attendees associated with the expense.", "nullable": true }, "potentialDuplicates": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The expense potential duplicated expenses list Ids.", "nullable": true }, "ruleViolations": { "type": "array", "items": { "$ref": "#/components/schemas/RuleViolationExtendedResponse" }, "description": "The rule violations associated with the expense.", "nullable": true }, "changedInfo": { "type": "array", "items": { "enum": [ "Date", "Amount", "Currency", "ExchangeRate" ], "type": "string" }, "description": "The changed information for the expense Date, Amount, Currency and ExchangeRate fields.", "nullable": true }, "activity": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityExtendedResponse" }, "description": "The historical activity log of the expense.", "nullable": true }, "flags": { "$ref": "#/components/schemas/FlagsExtendedResponse" }, "auditFlags": { "type": "array", "items": { "type": "string" }, "description": "The Smart Audit violated checks.", "nullable": true } }, "additionalProperties": false, "description": "The get expense by UUID extended response model" }, "GetExpenseByIdFlagsResponse": { "type": "object", "properties": { "isSplitExpense": { "type": "boolean", "description": "Flag indicating if the expense is the result of a split" }, "isReimbursable": { "type": "boolean", "description": "Flag indicating if the expense is reimbursable" }, "hasAttachments": { "type": "boolean", "description": "Flag indicating if the expense has attachments" } }, "additionalProperties": false, "description": "The model for the flags in GetExpenseById response" }, "GetExpenseByIdResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the expense", "format": "uuid" }, "user": { "$ref": "#/components/schemas/UserResponse" }, "xpdReference": { "type": "string", "description": "The Xpd reference of the expense", "nullable": true }, "parentXpdReference": { "type": "string", "description": "The Xpd reference of the parent expense. Only populated for soft split child expenses.", "nullable": true }, "parentExpenseGuid": { "type": "string", "description": "The guid of the parent expense. Only populated for soft split child expenses.", "format": "uuid", "nullable": true }, "expenseDate": { "type": "string", "description": "The date of the expense in ISO-8601 format", "format": "date-time", "nullable": true }, "expenseType": { "enum": [ "Regular", "Mileage", "PerDiem", "CounterExpense" ], "type": "string", "description": "The type of the expense" }, "expenseStatus": { "enum": [ "Created", "Duplicate", "Processing", "Unreadable", "ToSubmit", "ToVerify", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Reimbursed" ], "type": "string", "description": "The expense status" }, "comment": { "type": "string", "description": "The comment added on the expense", "nullable": true }, "amount": { "type": "number", "description": "The amount of the expense in decimal", "format": "double", "nullable": true }, "currencyCode": { "type": "string", "description": "The three-letter ISO-4217 currency code of the expense", "nullable": true }, "group": { "$ref": "#/components/schemas/GroupResponse" }, "branch": { "$ref": "#/components/schemas/BranchResponse" }, "category": { "$ref": "#/components/schemas/CategoryResponse" }, "project": { "$ref": "#/components/schemas/ProjectResponse" }, "countryCode": { "type": "string", "description": "The three-letter country code of the expense. ISO 3166-1 alpha-3 code.", "nullable": true }, "location": { "$ref": "#/components/schemas/LocationResponse" }, "trip": { "$ref": "#/components/schemas/TripResponse" }, "receipt": { "$ref": "#/components/schemas/ReceiptResponse" }, "regular": { "$ref": "#/components/schemas/RegularExpenseResponse" }, "mileage": { "$ref": "#/components/schemas/MileageExpenseResponse" }, "perDiem": { "$ref": "#/components/schemas/PerDiemExpenseResponse" }, "customFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueResponse" }, "description": "The custom field values of the expense", "nullable": true }, "exchangeRates": { "type": "array", "items": { "$ref": "#/components/schemas/ExchangeRateResponse" }, "description": "The collection of exchange rates", "nullable": true }, "attendees": { "type": "array", "items": { "$ref": "#/components/schemas/AttendeeResponse" }, "description": "The collection of mentions", "nullable": true }, "numberOfAttendees": { "type": "integer", "description": "The number of people the expense is shared with: the attendees plus the expense owner, unless the owner was excluded. Only populated for regular expenses.", "format": "int32", "nullable": true }, "ownerExcluded": { "type": "boolean", "description": "Indicates whether the expense owner was deliberately left out of the attendees. Only populated for regular expenses.", "nullable": true }, "amountPerAttendee": { "type": "number", "description": "The amount of the expense divided by the number of attendees, in the currency of the expense. Zero when there is no amount or nobody to divide it over. Not populated for mileage and per diem expenses.", "format": "double", "nullable": true }, "flags": { "$ref": "#/components/schemas/GetExpenseByIdFlagsResponse" } }, "additionalProperties": false, "description": "The get expense by UUID response model" }, "GetTransactionsResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "processorTransactionId": { "type": "string", "nullable": true }, "transactionDate": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Failed", "Pending", "Reversed", "Completed", "Refunded" ], "type": "string" }, "merchant": { "type": "string", "nullable": true }, "originalCurrency": { "type": "string", "nullable": true }, "originalAmount": { "type": "number", "format": "double" }, "billedCurrency": { "type": "string", "nullable": true }, "billedAmount": { "type": "number", "format": "double" }, "matchingStatus": { "enum": [ "None", "MatchFound", "Confirmed" ], "type": "string" }, "matchedExpenses": { "type": "array", "items": { "$ref": "#/components/schemas/MatchedExpense" }, "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethod" }, "user": { "$ref": "#/components/schemas/User" }, "merchantCategory": { "$ref": "#/components/schemas/MerchantCategory" }, "calculatedCurrencies": { "type": "array", "items": { "$ref": "#/components/schemas/CalculatedCurrency" }, "nullable": true }, "additionalProperties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Group": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "parentGroup": { "$ref": "#/components/schemas/GroupRef" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "isActive": { "type": "boolean" }, "ignoreApproval": { "type": "boolean" } }, "additionalProperties": false }, "GroupAssignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "GroupChange": { "type": "object", "properties": { "parentGroup": { "$ref": "#/components/schemas/GroupRef" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "isActive": { "type": "boolean" }, "ignoreApproval": { "type": "boolean" } }, "additionalProperties": false }, "GroupExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The group unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the group.", "nullable": true }, "groupId": { "type": "string", "description": "The group identifier.", "nullable": true } }, "additionalProperties": false, "description": "Represents the group associated with the expense." }, "GroupModel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the group", "format": "uuid" }, "name": { "type": "string", "description": "The name of the group", "nullable": true }, "branchId": { "type": "string", "description": "The UUID of the branch that the group is in", "format": "uuid" }, "groupId": { "type": "string", "description": "The secondary id of the group", "nullable": true } }, "additionalProperties": false, "description": "The model of a group" }, "GroupSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "hasChildren": { "type": "boolean" }, "isActive": { "type": "boolean" } }, "additionalProperties": false }, "GroupsApproverAssignment": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentGroup" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "Guest": { "type": "object", "properties": { "fullName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "externalOrganizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdFilter": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isExclusive": { "type": "boolean" } }, "additionalProperties": false }, "IntegrationConnection": { "required": [ "accessToken", "requestToken", "requestTokenSecret" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "integrationConnectionSettings": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationConnectionSetting" }, "nullable": true }, "branchesMapped": { "type": "boolean", "nullable": true }, "crossSettingsEnabled": { "type": "boolean" }, "account": { "type": "string", "nullable": true }, "accessToken": { "type": "string" }, "requestToken": { "type": "string" }, "requestTokenSecret": { "type": "string" }, "formId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationConnectionBase": { "required": [ "accessToken", "requestToken", "requestTokenSecret" ], "type": "object", "properties": { "accessToken": { "type": "string" }, "requestToken": { "type": "string" }, "requestTokenSecret": { "type": "string" }, "formId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntegrationConnectionSetting": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "reimbursableExportAs": { "enum": [ "Default", "Expense", "Invoice", "Transaction" ], "type": "string", "nullable": true }, "reimbursableExpenseStatus": { "enum": [ "Default", "Draft", "AwaitingApproval", "AwaitingPayment" ], "type": "string", "nullable": true }, "companyExportAs": { "enum": [ "Default", "Expense", "Invoice", "Transaction" ], "type": "string", "nullable": true }, "companyExpenseStatus": { "enum": [ "Default", "Draft", "AwaitingApproval", "AwaitingPayment" ], "type": "string", "nullable": true }, "importTrackingCategories": { "type": "boolean", "nullable": true }, "branches": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "importEmployeesAsInactive": { "type": "boolean", "nullable": true }, "autoSyncFromIntegration": { "type": "boolean", "nullable": true }, "autoSyncToIntegration": { "type": "boolean", "nullable": true }, "syncTime": { "type": "string", "format": "date-time", "nullable": true }, "importSupervisors": { "type": "boolean", "nullable": true }, "importSupervisorsAs": { "enum": [ "Administrator", "Approver", "Controller", "Director", "Finance", "User", "BranchManager", "Analyst", "ApiManager" ], "type": "string", "nullable": true }, "importTaxes": { "type": "boolean", "nullable": true }, "exportNonReimbursableExpenses": { "type": "boolean", "nullable": true }, "reimbursableFormId": { "type": "string", "nullable": true }, "syncTaxRatesEnabled": { "type": "boolean", "nullable": true }, "syncProjectsEnabled": { "type": "boolean", "nullable": true }, "approvalLevelForExportedExpenseReports": { "enum": [ "None", "SupervisorApproved", "AccountingApproved", "Both" ], "type": "string", "nullable": true }, "personalPaymentMethod": { "type": "boolean", "nullable": true }, "companyPaymentMethod": { "type": "boolean", "nullable": true }, "centralPaymentAccount": { "$ref": "#/components/schemas/BankAccount" }, "associatedBranches": { "type": "array", "items": { "$ref": "#/components/schemas/Branch" }, "nullable": true }, "useDefaultCorporateCard": { "type": "boolean", "nullable": true }, "externalCompanyId": { "type": "string", "nullable": true }, "journal": { "type": "string", "nullable": true }, "reimburseSetting": { "enum": [ "Default", "OnUser", "OnUserTotalsPerMonth" ], "type": "string", "nullable": true }, "bundleReimbursableExpensesByUser": { "type": "boolean", "nullable": true }, "useGroupAsCostCenter": { "type": "boolean", "nullable": true }, "importProjects": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IntegrationForm": { "type": "object", "properties": { "externalId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isPreferable": { "type": "boolean" } }, "additionalProperties": false }, "Language": { "type": "object", "properties": { "culture": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LimitationChain": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "limitations": { "type": "array", "items": { "$ref": "#/components/schemas/LimitationChainItem" }, "nullable": true } }, "additionalProperties": false }, "LimitationChainItem": { "type": "object", "properties": { "customField": { "type": "string", "nullable": true }, "condition": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Limitations": { "type": "object", "properties": { "expense": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "mileageExpense": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "perDiem": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "advance": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "trip": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "group": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "project": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" }, "user": { "enum": [ "Unavailable", "Required", "Optional" ], "type": "string" } }, "additionalProperties": false }, "LinkedAccountsAll": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "linkedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedAccountsAllItem" }, "nullable": true } }, "additionalProperties": false }, "LinkedAccountsAllItem": { "type": "object", "properties": { "linkedAccountUserId": { "type": "string", "format": "uuid" }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "LinkedAccountsUser": { "type": "object", "properties": { "linkedAccountUserId": { "type": "string", "format": "uuid" }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ListItemIds": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ListItemLimitations": { "type": "object", "properties": { "branchId": { "type": "string", "nullable": true }, "projectId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListItemSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "externalId": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "billingLegalEntityId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListItemTravelApprovers": { "type": "object", "properties": { "approvers": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "conflictApprovers": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ListItemUserAssignment": { "type": "object", "properties": { "userId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ListItemUserAssignmentBulkResult": { "type": "object", "properties": { "status": { "enum": [ "Added", "Updated", "Error" ], "type": "string" }, "error": { "type": "string", "nullable": true }, "warning": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LocationExtendedExpense": { "type": "object", "properties": { "id": { "type": "string", "description": "The location unique identifier.", "format": "uuid" }, "city": { "type": "string", "description": "The city of the location.", "nullable": true }, "region": { "type": "string", "description": "The region of the location.", "nullable": true }, "country": { "type": "string", "description": "The country of the location.", "nullable": true }, "geoLocation": { "$ref": "#/components/schemas/GeoLocationExtendedExpense" } }, "additionalProperties": false, "description": "Represents the location associated with the expense." }, "LocationResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the location", "format": "uuid" }, "city": { "type": "string", "description": "The city the location", "nullable": true }, "region": { "type": "string", "description": "The region of the location", "nullable": true }, "country": { "type": "string", "description": "The country of the location", "nullable": true } }, "additionalProperties": false, "description": "The model for location" }, "MatchedExpense": { "type": "object", "properties": { "xpdId": { "type": "string", "nullable": true }, "expenseGuid": { "type": "string", "format": "uuid" }, "status": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string" } }, "additionalProperties": false }, "MatchedTransactionExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "processorId": { "type": "string", "nullable": true }, "merchantCategoryCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantCategory": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The merchant unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the merchant.", "nullable": true }, "merchantVatNumber": { "type": "string", "description": "The VAT number of the merchant.", "nullable": true } }, "additionalProperties": false, "description": "Represents the merchant associated with the expense." }, "MerchantRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MerchantResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The merchant UUID of the expense", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "The merchant name of the expense", "nullable": true }, "merchantVatNumber": { "type": "string", "description": "The merchant's VAT Number", "nullable": true } }, "additionalProperties": false, "description": "The model for a single merchant" }, "MileageDestination": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MileageExpenseExtendedResponse": { "type": "object", "properties": { "rate": { "$ref": "#/components/schemas/MileageRateExtendedResponse" }, "distanceKm": { "type": "number", "description": "The distance of the mileage in kilometers.", "format": "double" }, "isBackAndForth": { "type": "boolean", "description": "The value indicating whether the trip is back and forth." }, "wayPoints": { "type": "array", "items": { "$ref": "#/components/schemas/WayPoint" }, "description": "The waypoints of the mileage.", "nullable": true } }, "additionalProperties": false, "description": "The details of a mileage expense." }, "MileageExpenseResponse": { "type": "object", "properties": { "wayPoints": { "type": "array", "items": { "$ref": "#/components/schemas/WayPointResponse" }, "description": "The way points of the mileage expense", "nullable": true }, "rate": { "$ref": "#/components/schemas/MileageRateResponse" }, "isBackAndForth": { "type": "boolean", "description": "Flag indicating if the mileage is back and forth" }, "distance": { "type": "number", "description": "The distance of the mileage expense\r\nThe metric of the distance is always Kilometers", "format": "double" } }, "additionalProperties": false }, "MileageExpenseSummary": { "type": "object", "properties": { "isBackAndForth": { "type": "boolean" }, "distance": { "type": "number", "format": "double" }, "fromAddress": { "type": "string", "nullable": true }, "toAddress": { "type": "string", "nullable": true }, "unit": { "enum": [ "Unknown", "Kilometer", "Mile" ], "type": "string" }, "numberOfOccurences": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MileageRateExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The rate unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the mileage rate.", "nullable": true }, "code": { "type": "string", "description": "The code of the mileage rate.", "nullable": true } }, "additionalProperties": false, "description": "Represents a mileage rate." }, "MileageRateRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MileageRateResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the mileage rate", "format": "uuid" }, "name": { "type": "string", "description": "The name of the mileage rate", "nullable": true } }, "additionalProperties": false, "description": "The model of a mileage rate" }, "MobileSettings": { "type": "object", "properties": { "refreshInterval": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ModifyApproverAssignment": { "type": "object", "properties": { "users": { "$ref": "#/components/schemas/AddOrRemoveUsers" } }, "additionalProperties": false }, "ModifyApproverBranchesAssignment": { "type": "object", "properties": { "branches": { "$ref": "#/components/schemas/AddOrRemoveBranch" } }, "additionalProperties": false }, "ModifyApproverGroupsAssignment": { "type": "object", "properties": { "groups": { "$ref": "#/components/schemas/AddOrRemoveGroup" } }, "additionalProperties": false }, "ModifyApproverProjectsAssignment": { "type": "object", "properties": { "projects": { "$ref": "#/components/schemas/AddOrRemoveProject" } }, "additionalProperties": false }, "ModifyCustomFieldValuesApproverAssignment": { "type": "object", "properties": { "customFieldValues": { "$ref": "#/components/schemas/CustomFieldValues" } }, "additionalProperties": false }, "MultiResultCounted_Of_Object": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int32" }, "data": { "type": "array", "items": { }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_AppOverview": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AppOverview" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_BankAccount": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccount" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_Branch": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Branch" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_BranchSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BranchSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_BusinessUnit": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessUnit" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CashAdvance": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CashAdvance" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CategorySummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CategorySummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ClientOverview": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClientOverview" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CommonProjectSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommonProjectSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CommonUserSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CommonUserSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CompanyCustomFieldSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCustomFieldSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CustomField": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomField" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_CustomFieldListItem": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldListItem" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ExistingExternalOrganization": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExistingExternalOrganization" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ExpenseGroupSummaryModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseGroupSummaryModel" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ExpenseSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ExpenseToBeReported": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseToBeReported" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_FtpFolder": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FtpFolder" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_GetTransactionsResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetTransactionsResponse" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_GroupSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_Guid": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_IntegrationForm": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntegrationForm" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_LimitationChain": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LimitationChain" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_LinkedAccountsAll": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedAccountsAll" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_LinkedAccountsUser": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedAccountsUser" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ListItemSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ListItemUserAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ListItemUserAssignment" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_NetSuiteEmployee": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NetSuiteEmployee" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_Object": { "type": "object", "properties": { "data": { "type": "array", "items": { }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_PaymentMethodSummaryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodSummaryResult" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_PolicyReasonSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyReasonSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ProjectSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ReimburseExpenseResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReimburseExpenseResult" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ReimbursementSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReimbursementSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_SSOConfiguration": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/SSOConfiguration" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_ScopesModel": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ScopesModel" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_TaxRateSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaxRateSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_TripSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TripSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MultiResult_Of_YourExpenses": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/YourExpenses" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "MyExpenses": { "type": "object", "properties": { "amountWaitingToBeSubmitted": { "type": "number", "format": "double" }, "amountWaitingToBeApproved": { "type": "number", "format": "double" }, "amountWaitingToBeControlled": { "type": "number", "format": "double" }, "amountWaitingToBeReported": { "type": "number", "format": "double" }, "currency": { "type": "string", "nullable": true }, "currencySymbol": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NetSuiteEmployee": { "type": "object", "properties": { "userName": { "type": "string", "nullable": true }, "internalId": { "type": "string", "nullable": true }, "approverId": { "type": "string", "nullable": true }, "subsidiaryId": { "type": "string", "nullable": true }, "subsidiaryName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "departmentName": { "type": "string", "nullable": true }, "departmentId": { "type": "string", "nullable": true }, "supervisorId": { "type": "string", "nullable": true }, "active": { "type": "boolean" }, "excludeFromRydoo": { "type": "boolean" }, "jobPosition": { "type": "string", "nullable": true }, "nationality": { "type": "string", "nullable": true }, "dateOfBirth": { "type": "string", "format": "date-time", "nullable": true }, "rydooUserGuid": { "type": "string", "format": "uuid", "nullable": true }, "hireDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "NetSuiteLoginTestResult": { "type": "object", "properties": { "isSuccess": { "type": "boolean" } }, "additionalProperties": false }, "Notifications": { "type": "object", "properties": { "numberOfNewReimburseReports": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Operation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PartialUpdate_Of_CommonProject": { "type": "object", "properties": { "jsonBody": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethod": { "type": "object", "properties": { "paymentMethodType": { "enum": [ "DebitCard", "CreditCard", "Prepaid", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" }, "cardNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "enum": [ "Cash", "DebetCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "cardNumber": { "type": "string", "nullable": true }, "ownership": { "enum": [ "Personal", "Company" ], "type": "string" } }, "additionalProperties": false }, "PaymentMethodExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The payment method unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the payment method.", "nullable": true }, "type": { "enum": [ "Cash", "DebetCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo" ], "type": "string", "description": "the type of the payment method." }, "ownership": { "enum": [ "Default", "Personal", "Company" ], "type": "string", "description": "The ownership of the payment method.", "nullable": true } }, "additionalProperties": false, "description": "The payment method associated with the expense." }, "PaymentMethodMultiActionResult": { "type": "object", "properties": { "paymentMethodId": { "type": "string", "format": "uuid" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the payment method", "format": "uuid" }, "name": { "type": "string", "description": "The name of the payment method", "nullable": true }, "type": { "enum": [ "Cash", "DebetCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo" ], "type": "string", "description": "The type of the payment method" }, "ownership": { "enum": [ "Default", "Personal", "Company" ], "type": "string", "description": "The ownership of the payment method. E.g.: Personal, Company, Default or null.", "nullable": true } }, "additionalProperties": false, "description": "The model of a payment method" }, "PaymentMethodResult": { "required": [ "accountOwnership", "cardName", "paymentMethodType", "user" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "lastSendCardValidationMailTime": { "type": "string", "format": "date-time", "nullable": true }, "validationStatus": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string", "nullable": true }, "isReimbursable": { "type": "boolean" }, "user": { "$ref": "#/components/schemas/PaymentMethodUser" }, "paymentMethodType": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" }, "accountOwnership": { "enum": [ "Personal", "Company" ], "type": "string" }, "accountNumber": { "type": "string", "nullable": true }, "travellerId": { "type": "string", "nullable": true }, "cardName": { "type": "string" }, "cardNumber": { "type": "string", "nullable": true }, "isDefault": { "type": "boolean" }, "isActive": { "type": "boolean" }, "cardType": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string", "nullable": true }, "accountingPaymentMethod": { "$ref": "#/components/schemas/BankAccount" }, "foreignPaymentExpenseIncreasePercentage": { "type": "number", "format": "double", "nullable": true }, "isAutoCreateExpenseEnabled": { "type": "boolean" }, "encryptedCardNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodSummaryResult": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "user": { "$ref": "#/components/schemas/PaymentMethodUser" }, "paymentMethodType": { "enum": [ "Cash", "DebitCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" }, "accountOwnership": { "enum": [ "Personal", "Company" ], "type": "string" }, "cardNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "validationStatus": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" }, "isReimbursable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "lastSendCardValidationMailTime": { "type": "string", "format": "date-time", "nullable": true }, "cardType": { "enum": [ "MasterCard", "Visa", "Amex", "Maestro", "Rydoo", "NordeaFirstCard" ], "type": "string", "nullable": true }, "bankOrigin": { "enum": [ "Kbc", "Belfius" ], "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodToBeClaimed": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "cardNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodTransaction": { "type": "object", "properties": { "transactionId": { "type": "integer", "format": "int32" }, "transactionDate": { "type": "string", "format": "date-time" }, "merchant": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PaymentMethodUser": { "type": "object", "properties": { "id": { "type": "string", "description": "GUID of the user that is the owner of the payment method", "format": "uuid" }, "userName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "avatarUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PerDiem": { "type": "object", "properties": { "region": { "$ref": "#/components/schemas/PerDiemRegion" }, "rate": { "$ref": "#/components/schemas/PerDiemRate" } }, "additionalProperties": false }, "PerDiemExpenseExtendedResponse": { "type": "object", "properties": { "startDate": { "type": "string", "description": "The start date of the per diem.", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "The end date of the per diem.", "format": "date-time", "nullable": true }, "duration": { "type": "string", "description": "The duration of the per diem expense in ISO 8601 format", "nullable": true }, "rate": { "$ref": "#/components/schemas/PerdiemRateExtendedResponse" }, "region": { "$ref": "#/components/schemas/RegionExtendedResponse" }, "appliedRateAmount": { "type": "number", "description": "The applied rate's amount in decimal", "format": "double", "nullable": true }, "deductions": { "type": "array", "items": { "$ref": "#/components/schemas/DeductionExtendedExpense" }, "description": "The collection of per diem expense deductions selected", "nullable": true }, "supplements": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementExtendedExpense" }, "description": "The collection of per diem expense supplements selected", "nullable": true } }, "additionalProperties": false, "description": "Represents the details of a per diem expense." }, "PerDiemExpenseResponse": { "type": "object", "properties": { "appliedRateAmount": { "type": "number", "description": "The applied rate's amount in decimal", "format": "double" }, "startDate": { "type": "string", "description": "The start date of the per diem expense", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "description": "The end date of the per diem expense", "format": "date-time", "nullable": true }, "duration": { "type": "string", "description": "The duration of the per diem expense in ISO 8601 format", "nullable": true }, "rate": { "$ref": "#/components/schemas/PerDiemRateResponse" }, "region": { "$ref": "#/components/schemas/PerDiemRegionResponse" }, "deductions": { "type": "array", "items": { "$ref": "#/components/schemas/DeductionResponse" }, "description": "The collection of per diem expense deductions selected", "nullable": true }, "supplements": { "type": "array", "items": { "$ref": "#/components/schemas/SupplementResponse" }, "description": "The collection of per diem expense supplements selected", "nullable": true } }, "additionalProperties": false }, "PerDiemRate": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PerDiemRateResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the per diem rate", "format": "uuid" }, "name": { "type": "string", "description": "The name of the per diem rate", "nullable": true } }, "additionalProperties": false, "description": "The model for a per diem rate" }, "PerDiemRegion": { "type": "object", "properties": { "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PerDiemRegionResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the per diem region", "format": "uuid" }, "name": { "type": "string", "description": "The name of the per diem region", "nullable": true } }, "additionalProperties": false, "description": "The model for a per diem region" }, "PerdiemRateExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The rate unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the per diem rate.", "nullable": true }, "code": { "type": "string", "description": "The code of the per diem rate.", "nullable": true } }, "additionalProperties": false, "description": "Represents a per diem rate." }, "PolicyReason": { "required": [ "fallbackLanguage", "policyReasonTranslations", "reasonType" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isActive": { "type": "boolean" }, "reasonType": { "enum": [ "Approve", "Reject" ], "type": "string" }, "rejectType": { "enum": [ "MatchingCardTransactionMissing", "ProjectIncorrect", "CategoryIncorrect", "ReceiptIncorrectOrMissing", "TripMissing", "DateIncorrect", "CurrencyIncorrect", "PaymentMethodIncorrect", "CountryMissing", "DuplicateExpense", "AttendeesMissing", "TaxRateIncorrectOrMissing", "OutOfPolicy", "MileageRateIncorrect", "ExpenseIsNotSplit", "ExpenseTooOld", "ReceiptUnreadble", "CheckInCheckOutDatesIncorrect", "PurposeUnclear", "Other" ], "type": "string", "nullable": true }, "approveType": { "enum": [ "PreApprovedExpense", "ExceptionalExpense", "ReceiptOrInvoiceLost", "Other" ], "type": "string", "nullable": true }, "policyReasonTranslations": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyReasonTranslation" } }, "fallbackLanguage": { "type": "string" } }, "additionalProperties": false }, "PolicyReasonChange": { "required": [ "fallbackLanguage", "policyReasonTranslations", "reasonType" ], "type": "object", "properties": { "isActive": { "type": "boolean" }, "reasonType": { "enum": [ "Approve", "Reject" ], "type": "string" }, "rejectType": { "enum": [ "MatchingCardTransactionMissing", "ProjectIncorrect", "CategoryIncorrect", "ReceiptIncorrectOrMissing", "TripMissing", "DateIncorrect", "CurrencyIncorrect", "PaymentMethodIncorrect", "CountryMissing", "DuplicateExpense", "AttendeesMissing", "TaxRateIncorrectOrMissing", "OutOfPolicy", "MileageRateIncorrect", "ExpenseIsNotSplit", "ExpenseTooOld", "ReceiptUnreadble", "CheckInCheckOutDatesIncorrect", "PurposeUnclear", "Other" ], "type": "string", "nullable": true }, "approveType": { "enum": [ "PreApprovedExpense", "ExceptionalExpense", "ReceiptOrInvoiceLost", "Other" ], "type": "string", "nullable": true }, "policyReasonTranslations": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyReasonTranslation" } }, "fallbackLanguage": { "type": "string" } }, "additionalProperties": false }, "PolicyReasonForExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyReasonSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "isActive": { "type": "boolean" }, "reasonType": { "enum": [ "Approve", "Reject" ], "type": "string" }, "rejectType": { "enum": [ "MatchingCardTransactionMissing", "ProjectIncorrect", "CategoryIncorrect", "ReceiptIncorrectOrMissing", "TripMissing", "DateIncorrect", "CurrencyIncorrect", "PaymentMethodIncorrect", "CountryMissing", "DuplicateExpense", "AttendeesMissing", "TaxRateIncorrectOrMissing", "OutOfPolicy", "MileageRateIncorrect", "ExpenseIsNotSplit", "ExpenseTooOld", "ReceiptUnreadble", "CheckInCheckOutDatesIncorrect", "PurposeUnclear", "Other" ], "type": "string", "nullable": true }, "approveType": { "enum": [ "PreApprovedExpense", "ExceptionalExpense", "ReceiptOrInvoiceLost", "Other" ], "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "languages": { "type": "array", "items": { "type": "string" }, "nullable": true }, "fallbackLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PolicyReasonTranslation": { "required": [ "language", "title" ], "type": "object", "properties": { "title": { "type": "string" }, "language": { "type": "string" } }, "additionalProperties": false }, "PossibleApproversOfExpense": { "type": "object", "properties": { "firstLineApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ApproverResult" }, "nullable": true }, "secondLineApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ApproverResult" }, "nullable": true }, "isFirstLineApprovalEnabled": { "type": "boolean" }, "isSecondLineApprovalEnabled": { "type": "boolean" } }, "additionalProperties": false }, "Project": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "maxLength": 512, "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "limitedToGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "isDefaultForGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "nullable": true } }, "additionalProperties": false }, "ProjectApprover": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ProjectApprovers": { "required": [ "expenseApprovers" ], "type": "object", "properties": { "expenseApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectApprover" }, "description": "List of users that are assigned as expense approvers for a specific project. You can provide multiple approvers. The unique user id needs to be provided as value which can be retrieved from the get user endpoint." }, "expenseConflictApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectApprover" }, "description": "List of users that are assigned as expense conflict approvers for a specific project. This approver will approve an expense if the expense needs to be approved for the project approver. You can provide multiple conflict approvers. The unique user id needs to be provided as value which can be retrieved from the get user endpoint.", "nullable": true }, "travelApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectApprover" }, "description": "List of users that are assigned as travel approvers for a specific project. You can provide multiple approvers. The unique user id needs to be provided as value which can be retrieved from the get user endpoint.", "nullable": true }, "travelConflictApprovers": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectApprover" }, "description": "List of users that are assigned as travel conflict approvers for a specific project. This approver will approve a booking if the booking needs to be approved for the project approver. You can provide multiple conflict approvers. The unique user id needs to be provided as value which can be retrieved from the get user endpoint.", "nullable": true } }, "additionalProperties": false }, "ProjectAssignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ProjectController": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "ProjectControllers": { "type": "object", "properties": { "controllers": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectController" }, "description": "List of users that are assigned as expense controllers for a specific project. You can provide multiple controllers. The unique user id needs to be provided as value. It can be retrieved from the get user endpoint.", "nullable": true } }, "additionalProperties": false }, "ProjectExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProjectExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The project unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the project.", "nullable": true }, "projectId": { "type": "string", "description": "The project identifier.", "nullable": true } }, "additionalProperties": false, "description": "Represents the project associated with the expense." }, "ProjectRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProjectResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the proect", "format": "uuid" }, "name": { "type": "string", "description": "The name of the project", "nullable": true }, "projectId": { "type": "string", "description": "The secondary Id of the project", "nullable": true } }, "additionalProperties": false, "description": "The model of a project" }, "ProjectSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "branchName": { "type": "string", "nullable": true }, "defaultForGroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "ProjectUpdate": { "type": "object", "properties": { "name": { "maxLength": 512, "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "branch": { "$ref": "#/components/schemas/BranchRef" }, "limitedToGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "isDefaultForGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "nullable": true } }, "additionalProperties": false }, "ProjectsApproverAssignment": { "type": "object", "properties": { "projects": { "type": "array", "items": { "$ref": "#/components/schemas/AssignmentProject" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ReceiptExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The receipt unique identifier.", "format": "uuid" }, "originalLink": { "type": "string", "description": "The original link to the receipt.", "nullable": true }, "signedPdfLink": { "type": "string", "description": "The signed PDF link of the receipt.", "nullable": true } }, "additionalProperties": false, "description": "Represents the receipt attached tp the expense." }, "ReceiptResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the receipt", "format": "uuid", "nullable": true }, "totalPages": { "type": "integer", "description": "The total amount of pages in the receipt", "format": "int32" } }, "additionalProperties": false, "description": "The model for a receipt" }, "ReferenceData": { "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/Country" }, "nullable": true }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/Currency" }, "nullable": true }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" }, "nullable": true } }, "additionalProperties": false }, "RegionExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The per diem region unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the per diem region.", "nullable": true } }, "additionalProperties": false, "description": "Represents a region of the per diem expense." }, "RegularExpenseChange": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/GroupRef" }, "originalAmount": { "type": "number", "format": "double", "nullable": true }, "originalCurrency": { "type": "string", "nullable": true }, "tax": { "$ref": "#/components/schemas/ExpenseTax" }, "isInvoice": { "type": "boolean" }, "invoiceNumber": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "merchant": { "$ref": "#/components/schemas/MerchantRef" }, "country": { "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectRef" }, "isReimbursable": { "type": "boolean" }, "date": { "type": "string", "format": "date-time" }, "category": { "$ref": "#/components/schemas/CategoryRef" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "nullable": true }, "advance": { "$ref": "#/components/schemas/AdvanceRef" }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodRef" }, "trip": { "$ref": "#/components/schemas/TripRef" }, "link": { "$ref": "#/components/schemas/ExpenseLink" } }, "additionalProperties": false }, "RegularExpenseExtendedResponse": { "type": "object", "properties": { "taxPercentage": { "type": "number", "description": "The tax percentage.", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "description": "The tax amount.", "format": "double", "nullable": true }, "netAmount": { "type": "number", "description": "The net amount.", "format": "double", "nullable": true }, "matchStatus": { "enum": [ "NoMatch", "MatchFound", "MatchConfirmed" ], "type": "string", "description": "the transaction match status of the expense." }, "checkInDate": { "type": "string", "description": "The check-in date.", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "description": "The check-out date.", "format": "date-time", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodExtendedResponse" }, "advance": { "$ref": "#/components/schemas/AdvanceExtendedResponse" }, "taxRate": { "$ref": "#/components/schemas/TaxRateExtendedResponse" }, "merchant": { "$ref": "#/components/schemas/MerchantExtendedResponse" }, "matchedTransaction": { "$ref": "#/components/schemas/MatchedTransactionExtendedResponse" }, "isInvoice": { "type": "boolean", "description": "Value indicating whether the expense is an invoice." }, "invoiceNumber": { "type": "string", "description": "The invoice number of the expense.", "nullable": true } }, "additionalProperties": false, "description": "Represents details of a regular expense." }, "RegularExpenseResponse": { "type": "object", "properties": { "taxPercentage": { "type": "number", "description": "The tax percentage of the expense", "format": "double", "nullable": true }, "taxAmount": { "type": "number", "description": "The tax amount of the expense", "format": "double", "nullable": true }, "netAmount": { "type": "number", "description": "The Net amount of the expense if expense has Tax amount set", "format": "double", "nullable": true }, "matchStatus": { "enum": [ "NoMatch", "MatchFound", "MatchConfirmed" ], "type": "string", "description": "The match status of the expense" }, "checkInDate": { "type": "string", "description": "The check-in date of the expense in ISO-8601 format", "format": "date-time", "nullable": true }, "checkOutDate": { "type": "string", "description": "The check-out date of the expense in ISO-8601 format", "format": "date-time", "nullable": true }, "paymentMethod": { "$ref": "#/components/schemas/PaymentMethodResponse" }, "advance": { "$ref": "#/components/schemas/AdvanceResponse" }, "taxRate": { "$ref": "#/components/schemas/TaxRateResponse" }, "merchant": { "$ref": "#/components/schemas/MerchantResponse" }, "softSplitType": { "enum": [ "Parent", "Child" ], "type": "string", "description": "The soft split type of the expense", "nullable": true }, "taxRates": { "type": "array", "items": { "$ref": "#/components/schemas/TaxLineResponse" }, "description": "The tax lines of the expense", "nullable": true } }, "additionalProperties": false, "description": "The model of Regular Expense properties" }, "ReimburseExpenseData": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid" }, "paymentReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReimburseExpenseResult": { "type": "object", "properties": { "expenseId": { "type": "string", "format": "uuid" }, "xpdReference": { "type": "string", "nullable": true }, "expenseStatus": { "enum": [ "Creating", "Created", "Duplicate", "Processing", "Processed", "BadQuality", "ReadyForPreApproval", "Completed", "ToBeVerified", "Submitted", "Recalled", "Approved", "Rejected", "Controlled", "Reported", "Archived", "SubmittedForReporting", "PreApproved", "ReceiptUpdated", "Reimbursed", "Unreported", "Unapproved", "Uncontrolled" ], "type": "string", "nullable": true }, "errorCode": { "type": "integer", "format": "int32", "nullable": true }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReimbursementJobCountersResult": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "succeeded": { "type": "integer", "format": "int32" }, "failed": { "type": "integer", "format": "int32" }, "pending": { "type": "integer", "description": "Expenses that have not finished yet, including the ones being reimbursed right now.", "format": "int32" } }, "additionalProperties": false }, "ReimbursementJobItemResult": { "type": "object", "properties": { "sequence": { "type": "integer", "format": "int32" }, "expenseId": { "type": "string", "format": "uuid" }, "outcome": { "type": "string", "description": "PENDING, IN_PROGRESS, SUCCEEDED or FAILED. An already reimbursed expense is SUCCEEDED.", "nullable": true }, "errors": { "type": "array", "items": { "type": "string" }, "description": "Stable error codes explaining a failed expense, in a fixed order; empty when the expense succeeded.", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ReimbursementJobStatusResult": { "type": "object", "properties": { "jobId": { "type": "string", "format": "uuid" }, "state": { "type": "string", "description": "ACCEPTED, IN_PROGRESS, COMPLETED, COMPLETED_WITH_FAILURES or FAILED.", "nullable": true }, "counters": { "$ref": "#/components/schemas/ReimbursementJobCountersResult" }, "acceptedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "totalCount": { "type": "integer", "description": "Number of items matching the outcome filter, before pagination.", "format": "int32" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReimbursementJobItemResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "ReimbursementSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "walletId": { "type": "string", "nullable": true }, "branchId": { "type": "string", "format": "uuid" }, "amount": { "$ref": "#/components/schemas/AmountResponse" }, "status": { "enum": [ "InProgress", "Succeeded", "Failed", "Cancelled" ], "type": "string" }, "reimbursedAt": { "type": "string", "format": "date-time", "nullable": true }, "expenses": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseDetails" }, "nullable": true } }, "additionalProperties": false }, "RejectExpenseRequest": { "type": "object", "properties": { "rejectReasonId": { "type": "string", "description": "The id of the reject reason", "format": "uuid", "nullable": true }, "rejectReasonMessage": { "maxLength": 2000, "type": "string", "description": "The reject reason message", "nullable": true }, "role": { "enum": [ "Personal", "Approver", "Controller", "Director", "Finance" ], "type": "string", "description": "The role the user is acting as. E.g.: Approver, Controller, Finance", "nullable": true } }, "additionalProperties": false, "description": "Model of a reject expense request" }, "RejectExpensesData": { "type": "object", "properties": { "rejectReasonId": { "type": "string", "format": "uuid", "nullable": true }, "message": { "type": "string", "nullable": true }, "expenseIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "RejectReasonExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The reject reason unique identifier.", "format": "uuid" }, "title": { "type": "string", "description": "The title of the reject reason.", "nullable": true }, "message": { "type": "string", "description": "The message associated with the reject reason.", "nullable": true } }, "additionalProperties": false, "description": "Represents the reject reason for an expense historical activity." }, "Result": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "ResultLinks": { "type": "object", "properties": { "next": { "type": "string", "nullable": true }, "count": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ResultMessage": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Result_Of_PaymentMethodMultiActionResult": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodMultiActionResult" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodMultiActionResult" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodMultiActionResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "RoleAssignmentResult": { "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "code": { "type": "integer", "format": "int32" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RoleRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RuleViolationExtendedResponse": { "type": "object", "properties": { "ruleId": { "type": "string", "description": "The rule unique identifier.", "format": "uuid" }, "ruleName": { "type": "string", "description": "The name of the rule violation.", "nullable": true }, "ruleMessage": { "type": "string", "description": "The message of the rule violation.", "nullable": true }, "totalAmount": { "type": "number", "description": "The total amount of the rule violation.", "format": "double", "nullable": true }, "severityLevel": { "enum": [ "Information", "Warning", "OutOfPolicy" ], "type": "string", "description": "The severity level of the rule violation." } }, "additionalProperties": false, "description": "Represents a rule violated by the expense." }, "SSOCertificate": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "publicKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SSOCertificates": { "type": "object", "properties": { "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/SSOCertificate" }, "nullable": true } }, "additionalProperties": false }, "SSOConfiguration": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "protocol": { "enum": [ "Unknown", "Saml20", "WsFederation" ], "type": "string" }, "ssoIdType": { "enum": [ "Unknown", "Unspecified", "Email" ], "type": "string" }, "issuer": { "type": "string", "nullable": true }, "metadataUrl": { "type": "string", "nullable": true }, "singleSignOnServiceUrl": { "type": "string", "nullable": true }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/SSOCertificate" }, "nullable": true }, "isEnabled": { "type": "boolean", "nullable": true }, "singleLogoutServiceUrl": { "type": "string", "nullable": true }, "skipGatekeeper": { "type": "boolean" }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Company" }, "nullable": true }, "idpInitiatedFlowEnabled": { "type": "boolean" }, "useGenericSamlAcsEndpoint": { "type": "boolean" } }, "additionalProperties": false }, "ScopesModel": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "added": { "type": "boolean" } }, "additionalProperties": false }, "SearchLimitationChains": { "type": "object", "properties": { "limitations": { "type": "array", "items": { "$ref": "#/components/schemas/LimitationChainItem" }, "nullable": true } }, "additionalProperties": false }, "SetPaidRequest": { "type": "object", "properties": { "paymentReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SetPaidResponse": { "type": "object", "properties": { "cashAdvanceId": { "type": "string", "format": "uuid" }, "state": { "enum": [ "Draft", "PendingApproval", "WaitingPayment", "Paid", "Rejected", "Closed" ], "type": "string" } }, "additionalProperties": false }, "SetTreasurerPermissionRequest": { "type": "object", "properties": { "permission": { "enum": [ "Authoriser", "Reviewer" ], "type": "string" } }, "additionalProperties": false }, "SingleResult_Of_AccountTracker": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AccountTracker" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_AppModel": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppModel" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverAssignment" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverAssignment_And_RoleAssignmentResult_And_RoleAssignmentResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverAssignment" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverBranchesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverBranchesResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverCustomFieldValuesResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverCustomFieldValuesResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverGroupsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverGroupsResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverProjectsResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverProjectsResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ApproverUsersResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproverUsersResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_CompanyCurrencySummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCurrencySummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_ExtendedRoleAssigment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedRoleAssigment" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_PaymentMethodToBeClaimed": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodToBeClaimed" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_PaymentMethodTransaction": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodTransaction" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_PolicyReasonForExpenseSummary": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PolicyReasonForExpenseSummary" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_UserGroupAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupAssignment" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_UserPaymentMethod": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserPaymentMethod" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Array_Of_UserRoleAssignment": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserRoleAssignment" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Boolean": { "type": "object", "properties": { "data": { "type": "boolean" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Branch": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Branch" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Category": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Category" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ChangeExpenseStatusResults": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ChangeExpenseStatusResults" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Client": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Client" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_CompanyCustomField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyCustomField" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_CompanyMessage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyMessage" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ControllerAssignment": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ControllerAssignment" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ControllerAssignment_And_RoleAssignmentResult_And_RoleAssignmentResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ControllerAssignment" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Counts": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Counts" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_CustomField": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomField" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_CustomFieldListItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldListItem" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_CustomFieldRoleCombinations": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CustomFieldRoleCombinations" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_EmbedConfig": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmbedConfig" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ExistingCommonProject": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExistingCommonProject" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ExistingCommonUser": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExistingCommonUser" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ExistingCompanyCustomFieldListItem": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExistingCompanyCustomFieldListItem" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Expense": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Expense" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_FtpConnection": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FtpConnection" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_FtpFolder": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FtpFolder" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_FtpFolderDetails": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FtpFolderDetails" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Group": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Group" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Int32": { "type": "object", "properties": { "data": { "type": "integer", "format": "int32" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_IntegrationConnection": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationConnection" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_IntegrationConnectionSetting": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntegrationConnectionSetting" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ListItemTravelApprovers": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ListItemTravelApprovers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_List_Of_Guid": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_List_Of_String": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_MobileSettings": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MobileSettings" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_MyExpenses": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MyExpenses" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_NetSuiteLoginTestResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NetSuiteLoginTestResult" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Notifications": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Notifications" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_PaymentMethodResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PaymentMethodResult" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_PolicyReason": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PolicyReason" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_PossibleApproversOfExpense": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PossibleApproversOfExpense" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Project": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Project" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ProjectApprovers": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectApprovers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ProjectControllers": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProjectControllers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_ReferenceData": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ReferenceData" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_Result": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Result" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_SSOCertificate": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SSOCertificate" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_SSOCertificates": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SSOCertificates" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_SSOConfiguration": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SSOConfiguration" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_SetPaidResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SetPaidResponse" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_State": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/State" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_SubsidiaryDetails": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SubsidiaryDetails" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_TodoCounts": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TodoCounts" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_UserApprovers": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserApprovers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_UserApprovers_And_RoleAssignmentResult_And_RoleAssignmentResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserApprovers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_UserControllers": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserControllers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_UserControllers_And_RoleAssignmentResult_And_RoleAssignmentResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserControllers" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/RoleAssignmentResult" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_UserTrip": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserTrip" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "SingleResult_Of_WebHook": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/WebHook" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ResultMessage" }, "nullable": true }, "links": { "$ref": "#/components/schemas/ResultLinks" } }, "additionalProperties": false }, "State": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false }, "SubmitExpenseRequest": { "type": "object", "properties": { "replyMessage": { "maxLength": 2000, "type": "string", "description": "The reply message", "nullable": true } }, "additionalProperties": false, "description": "The model to submit an expense" }, "SubsidiaryDetails": { "type": "object", "properties": { "rydooSubsidiaries": { "type": "array", "items": { "$ref": "#/components/schemas/Branch" }, "nullable": true }, "netSuiteSubsidiaries": { "type": "array", "items": { "$ref": "#/components/schemas/Branch" }, "nullable": true }, "mappedSubsidiaries": { "type": "array", "items": { "$ref": "#/components/schemas/SubsidiaryLink" }, "nullable": true }, "integrationId": { "type": "integer", "format": "int32" }, "crossSettingsEnabled": { "type": "boolean" } }, "additionalProperties": false }, "SubsidiaryLink": { "type": "object", "properties": { "rydooSubsidiary": { "$ref": "#/components/schemas/Branch" }, "netSuiteSubsidiary": { "$ref": "#/components/schemas/Branch" } }, "additionalProperties": false }, "SupplementExtendedExpense": { "type": "object", "properties": { "id": { "type": "string", "description": "The supplement unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the supplement.", "nullable": true }, "amount": { "type": "number", "description": "The amount of the supplement.", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "Represents a per diem supplement." }, "SupplementResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the supplement", "format": "uuid" }, "name": { "type": "string", "description": "The name of the supplement", "nullable": true }, "amount": { "type": "number", "description": "The amount of the supplement", "format": "double" } }, "additionalProperties": false, "description": "The model of a supplement" }, "SyncBranchExchangeRatesRequest": { "required": [ "branchExchangeRates" ], "type": "object", "properties": { "branchId": { "type": "string", "format": "uuid" }, "startDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "branchExchangeRates": { "type": "array", "items": { "$ref": "#/components/schemas/BranchExchangeRateRequest" } } }, "additionalProperties": false }, "SyncBranchExchangeRatesResponse": { "type": "object", "properties": { "creationDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "SyncModel": { "type": "object", "properties": { "settingId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TaxExpenseSummary": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "rate": { "type": "number", "format": "double" }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxLineResponse": { "type": "object", "properties": { "taxRateId": { "type": "string", "description": "The UUID of the tax rate", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "The name of the tax rate", "nullable": true }, "rate": { "type": "number", "description": "The tax rate percentage", "format": "double" }, "baseAmount": { "type": "number", "description": "The base amount before tax", "format": "double" }, "taxAmount": { "type": "number", "description": "The tax amount", "format": "double" }, "subtotal": { "type": "number", "description": "The subtotal including tax", "format": "double" }, "xpdReference": { "type": "string", "description": "The XPD reference of the expense", "nullable": true }, "expenseGuid": { "type": "string", "description": "The unique identifier of the expense", "format": "uuid" } }, "additionalProperties": false, "description": "The model of a tax line" }, "TaxRateExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The tax rate unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the tax rate.", "nullable": true }, "code": { "type": "string", "description": "The code of the tax rate.", "nullable": true } }, "additionalProperties": false, "description": "Represents the tax rate associated with the expense." }, "TaxRateRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "code": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TaxRateResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the tax rate", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "The name of the tax rate", "nullable": true }, "code": { "type": "string", "description": "The code of the tax rate", "nullable": true } }, "additionalProperties": false, "description": "The model of a tax rate" }, "TaxRateSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double" }, "branchId": { "type": "string", "format": "uuid" }, "shouldBeSelected": { "type": "boolean" } }, "additionalProperties": false }, "TodoCounts": { "type": "object", "properties": { "numberOfTransactionsToMatch": { "type": "integer", "format": "int32" }, "numberOfAdvancesToApprove": { "type": "integer", "format": "int32" }, "numberOfExpensesToReport": { "type": "integer", "format": "int32" }, "numberOfExpensesToApprove": { "type": "integer", "format": "int32" }, "numberOfExpensesToControl": { "type": "integer", "format": "int32" }, "numberOfExpensesToSubmit": { "type": "integer", "format": "int32" }, "numberOfPaymentMethodsToValidate": { "type": "integer", "format": "int32" }, "numberOfTripsToApprove": { "type": "integer", "format": "int32" }, "numberOfTripsToControl": { "type": "integer", "format": "int32" }, "numberOfTripsToSubmit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TransactionExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TravelUserApprover": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TravelUserApprovers": { "type": "object", "properties": { "approvers": { "type": "array", "items": { "$ref": "#/components/schemas/TravelUserApprover" }, "nullable": true } }, "additionalProperties": false }, "TripAttachment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TripBudget": { "type": "object", "properties": { "currencyCode": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/TripBudgetCategory" }, "nullable": true } }, "additionalProperties": false }, "TripBudgetCategory": { "type": "object", "properties": { "categoryId": { "type": "string", "format": "uuid" }, "categoryName": { "type": "string", "nullable": true }, "amount": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TripCustomFieldValueRef": { "type": "object", "properties": { "type": { "enum": [ "FreeText", "List", "Numeric" ], "type": "string" }, "id": { "type": "string", "format": "uuid", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "format": "uuid", "nullable": true }, "ignoreIfNotFound": { "type": "boolean" } }, "additionalProperties": false }, "TripDestination": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "date": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "placeIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "location": { "$ref": "#/components/schemas/TripDestinationLocation" } }, "additionalProperties": false }, "TripDestinationChange": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time" }, "name": { "type": "string", "nullable": true }, "placeIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "countryCode": { "type": "string", "nullable": true }, "location": { "$ref": "#/components/schemas/TripDestinationLocation" } }, "additionalProperties": false }, "TripDestinationLocation": { "type": "object", "properties": { "lat": { "type": "number", "format": "double" }, "lng": { "type": "number", "format": "double" } }, "additionalProperties": false }, "TripExtendedExpense": { "type": "object", "properties": { "id": { "type": "string", "description": "The trip unique identifier.", "format": "uuid" }, "name": { "type": "string", "description": "The name of the trip.", "nullable": true }, "tripId": { "type": "string", "description": "the trip identifier.", "nullable": true }, "comment": { "type": "string", "description": "The comment on the trip.", "nullable": true }, "start": { "type": "string", "description": "The start date of the trip.", "format": "date-time" }, "end": { "type": "string", "description": "The end date of the trip.", "format": "date-time" } }, "additionalProperties": false, "description": "The tripa associated with the expense." }, "TripRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TripResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the trip", "format": "uuid" }, "name": { "type": "string", "description": "The name of the trip", "nullable": true }, "tripId": { "type": "string", "description": "The secondary Id of the trip", "nullable": true } }, "additionalProperties": false, "description": "The model of a trip" }, "TripStatusData": { "type": "object", "properties": { "tripId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "TripSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "userEmail": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "status": { "enum": [ "Created", "ToSubmit", "Submitted", "Approved", "Rejected", "Completed", "Controlled", "Recalled" ], "type": "string" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/TripDestination" }, "nullable": true }, "totalSpent": { "$ref": "#/components/schemas/TripTotalSpent" }, "numberOfExpenses": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TripTotalSpent": { "type": "object", "properties": { "amount": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UpdateAppRequest": { "required": [ "appName", "contactEmail" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "appName": { "maxLength": 80, "type": "string" }, "contactEmail": { "maxLength": 80, "type": "string", "format": "email" }, "postLogoutRedirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUrls": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scopes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "scopeList": { "type": "array", "items": { "$ref": "#/components/schemas/ScopesModel" }, "nullable": true } }, "additionalProperties": false }, "UpdateUserLinkedAccount": { "type": "object", "properties": { "linkedAccountUserId": { "type": "string", "format": "uuid" }, "permissions": { "type": "array", "items": { "type": "string" }, "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UploadReceiptResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the uploaded receipt", "format": "uuid" } }, "additionalProperties": false, "description": "The upload receipt reponse model" }, "User": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserApproverAssignment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "UserApprovers": { "type": "object", "properties": { "approvers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "UserControllers": { "type": "object", "properties": { "controllers": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true } }, "additionalProperties": false }, "UserCustomFieldValueExtendedResponse": { "type": "object", "properties": { "key": { "type": "string", "description": "The name of the custom field.", "nullable": true }, "value": { "type": "string", "description": "The assigned display or free-text value.", "nullable": true }, "valueCode": { "type": "string", "description": "The selected predefined value's code, if applicable.", "nullable": true } }, "additionalProperties": false, "description": "Represents a custom field value assigned to a user." }, "UserExpenseSummary": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserExtendedResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The user unique identifier.", "format": "uuid" }, "firstName": { "type": "string", "description": "The first name of the user.", "nullable": true }, "lastName": { "type": "string", "description": "The last name of the user.", "nullable": true }, "email": { "type": "string", "description": "The email of the user.", "nullable": true }, "externalId": { "type": "string", "description": "The external ID of the user.", "nullable": true }, "countryCode": { "type": "string", "description": "The country code of the user.", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/UserCustomFieldValueExtendedResponse" }, "description": "The custom fields assigned to the user.", "nullable": true } }, "additionalProperties": false, "description": "Represents the user that is the owner of the expense." }, "UserGroupAssignment": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/UserGroupRef" }, "startDate": { "pattern": "\\d{4}-\\d{2}-\\d{2}", "type": "string", "description": "Date by which the user entered / enters the group. \r\nFormat should be in YYYY-MM-DD", "nullable": true }, "endDate": { "pattern": "\\d{4}-\\d{2}-\\d{2}", "type": "string", "description": "Date by which the user left / leaves the group. \r\nFormat should be in YYYY-MM-DD", "nullable": true } }, "additionalProperties": false }, "UserGroupAssignmentChange": { "type": "object", "properties": { "group": { "$ref": "#/components/schemas/GroupRef" }, "startDate": { "pattern": "\\d{4}-\\d{2}-\\d{2}", "type": "string", "description": "Date by which the user entered / enters the group. \r\nFormat should be in YYYY-MM-DD", "nullable": true }, "endDate": { "pattern": "\\d{4}-\\d{2}-\\d{2}", "type": "string", "description": "Date by which the user left / leaves the group. \r\nFormat should be in YYYY-MM-DD", "nullable": true } }, "additionalProperties": false }, "UserGroupRef": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchRef" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "refId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserId": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "UserListItemAssignment": { "type": "object", "properties": { "listItemId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserListItemAssignmentBulkResult": { "type": "object", "properties": { "status": { "enum": [ "Added", "Updated", "Error" ], "type": "string" }, "error": { "type": "string", "nullable": true }, "warning": { "type": "string", "nullable": true }, "listItemId": { "type": "string", "nullable": true }, "startDate": { "type": "string", "nullable": true }, "endDate": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserPaymentMethod": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "cardNumber": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "accountType": { "enum": [ "Cash", "DebetCard", "CreditCard", "Transfer", "Paypal", "Prepaid", "Cheque", "AmericanExpress", "LodgeCard", "Kbc", "PurchaseCard", "Rydoo", "UbsVirtualCard", "OpenCard" ], "type": "string" }, "accountOwnership": { "enum": [ "Personal", "Company" ], "type": "string" }, "validationStatus": { "enum": [ "None", "PendingValidation", "Validated", "Failed", "OptOut" ], "type": "string" } }, "additionalProperties": false }, "UserPermissionBranchesChangeRequest": { "type": "object", "properties": { "branches": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true } }, "additionalProperties": false }, "UserRef": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "refId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserResponse": { "type": "object", "properties": { "id": { "type": "string", "description": "The UUID of the user", "format": "uuid" }, "firstName": { "type": "string", "description": "The first name of the user", "nullable": true }, "lastName": { "type": "string", "description": "The last name of the user", "nullable": true }, "email": { "type": "string", "description": "The email of the user", "nullable": true }, "externalId": { "type": "string", "description": "The external/ref Id of the user", "nullable": true } }, "additionalProperties": false, "description": "The model for a user" }, "UserRoleAssignment": { "type": "object", "properties": { "roleType": { "enum": [ "Administrator", "Approver", "Controller", "Director", "Finance", "User", "BranchManager", "Analyst", "ApiManager" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleRef" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRef" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchRef" }, "nullable": true } }, "additionalProperties": false }, "UserRoleAssignmentChange": { "type": "object", "properties": { "roleType": { "enum": [ "Administrator", "Approver", "Controller", "Director", "Finance", "User", "BranchManager", "Analyst", "ApiManager" ], "type": "string" }, "role": { "$ref": "#/components/schemas/RoleRef" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupRef" }, "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectRef" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserRef" }, "nullable": true }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchRef" }, "nullable": true } }, "additionalProperties": false }, "UserTrip": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "userId": { "type": "string", "format": "uuid" }, "userEmail": { "type": "string", "nullable": true }, "userName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "status": { "enum": [ "Created", "ToSubmit", "Submitted", "Approved", "Rejected", "Completed", "Controlled", "Recalled" ], "type": "string" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/TripDestination" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/TripCustomFieldValueRef" }, "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/TripAttachment" }, "nullable": true }, "budget": { "$ref": "#/components/schemas/TripBudget" }, "totalSpent": { "$ref": "#/components/schemas/TripTotalSpent" }, "hasPerDiemExpenses": { "type": "boolean" } }, "additionalProperties": false }, "UserTripAdding": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "source": { "enum": [ "Mobile", "Web", "Api", "Perk", "Egencia" ], "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "submitForApproval": { "type": "boolean" }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/TripDestinationChange" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "nullable": true }, "budget": { "$ref": "#/components/schemas/TripBudget" } }, "additionalProperties": false }, "UserTripUpdating": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "comment": { "type": "string", "nullable": true }, "isActive": { "type": "boolean" }, "refId": { "type": "string", "nullable": true }, "destinations": { "type": "array", "items": { "$ref": "#/components/schemas/TripDestination" }, "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueRef" }, "nullable": true }, "budget": { "$ref": "#/components/schemas/TripBudget" }, "submitForApproval": { "type": "boolean" } }, "additionalProperties": false }, "UsersApproverAssignment": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserApproverAssignment" }, "nullable": true }, "isAll": { "type": "boolean" } }, "additionalProperties": false }, "ViolatedRule": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of a rule", "format": "uuid" }, "name": { "type": "string", "description": "The name of rule", "nullable": true }, "showRuleViolationInExpense": { "type": "boolean", "description": "Indicates that rule violation should be displayed in expense" } }, "additionalProperties": false }, "WayPoint": { "type": "object", "properties": { "location": { "type": "string", "description": "The location of the waypoint.", "nullable": true } }, "additionalProperties": false, "description": "Represents a mileage waypoint." }, "WayPointResponse": { "type": "object", "properties": { "location": { "type": "string", "description": "The way point location", "nullable": true } }, "additionalProperties": false, "description": "The model for a mileage way point" }, "WebHook": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "eventType": { "enum": [ "AdvanceApproved", "ExpenseControlled" ], "type": "string" }, "url": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "WebHookChange": { "type": "object", "properties": { "eventType": { "enum": [ "AdvanceApproved", "ExpenseControlled" ], "type": "string" }, "url": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date-time", "nullable": true }, "endDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "YourExpenses": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "currency": { "type": "string", "nullable": true }, "groupName": { "type": "string", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "swagopenapi": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://accounts.rydoo.com/connect/token", "scopes": { "api_xpd2": "api_xpd2 is a scope used by xpenditure", "openid": "openid is a scope used by xpenditure" } } } } } }, "security": [ { "swagopenapi": [ "api_xpd2", "openid" ] } ], "x-samples-languages": [ "curl", "csharp", "php", "node", "ruby", "javascript", "python" ] }