{ "openapi": "3.0.1", "info": { "title": "FTS/V1.1", "version": "4" }, "servers": [ { "url": "https://sbx-firsttosite.myobadvanced.com/entity/FTS/V1.1" } ], "paths": { "/ItemsforWebIntegration/{actionName}": { "post": { "tags": [ "ItemsforWebIntegration" ], "summary": "Performs an action in the system.", "operationId": "ItemsforWebIntegration_InvokeAction_CustomAction", "parameters": [ { "$ref": "#/components/parameters/actionName" } ], "requestBody": { "description": "The record to which the action should be applied and the parameters of the action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegrationCustomAction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegrationCustomAction" } } }, "required": true, "x-bodyName": "invocation" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/InvokeAction_204" }, "202": { "$ref": "#/components/responses/InvokeAction_202" }, "400": { "$ref": "#/components/responses/InvokeAction_400" }, "412": { "$ref": "#/components/responses/InvokeAction_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } } }, "/ItemsforWebIntegration/$adHocSchema": { "get": { "tags": [ "ItemsforWebIntegration" ], "summary": "Retrieves the schema of custom fields of the entity from the system.", "operationId": "ItemsforWebIntegration_GetAdHocSchema", "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The field name, view name, and type of the fields that are not defined in the contract of the endpoint for this entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } } }, "/ItemsforWebIntegration/{ids}": { "get": { "tags": [ "ItemsforWebIntegration" ], "summary": "Retrieves a record by the values of its key fields from the system.", "operationId": "ItemsforWebIntegration_GetByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } }, "delete": { "tags": [ "ItemsforWebIntegration" ], "summary": "Deletes the record by the values of its key fields.", "operationId": "ItemsforWebIntegration_DeleteByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteByKeys_204" } } } }, "/ItemsforWebIntegration/{ids}/files/{filename}": { "put": { "tags": [ "ItemsforWebIntegration" ], "summary": "Attaches a file to a record.", "operationId": "ItemsforWebIntegration_PutFile", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/filename" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/PutFile_204" } } } }, "/ItemsforWebIntegration/{id}": { "get": { "tags": [ "ItemsforWebIntegration" ], "summary": "Retrieves a record by the value of the session entity ID from the system.", "operationId": "ItemsforWebIntegration_GetById", "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } }, "delete": { "tags": [ "ItemsforWebIntegration" ], "summary": "Deletes the record by its session identifier.", "operationId": "ItemsforWebIntegration_DeleteById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteById_204" } } } }, "/ItemsforWebIntegration": { "get": { "tags": [ "ItemsforWebIntegration" ], "summary": "Retrieves records that satisfy the specified conditions from the system.", "operationId": "ItemsforWebIntegration_GetList", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/top" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The list of records that satisfy the specified conditions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } } }, "put": { "tags": [ "ItemsforWebIntegration" ], "summary": "Creates a record or updates an existing record.", "operationId": "ItemsforWebIntegration_PutEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be passed to the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The created or updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } }, "400": { "$ref": "#/components/responses/PutEntity_400" }, "412": { "$ref": "#/components/responses/PutEntity_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } }, "patch": { "tags": [ "ItemsforWebIntegration" ], "summary": "Updates the fields of an existing record that are specified in the request body.", "operationId": "ItemsforWebIntegration_PatchEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be updated in the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } }, "400": { "$ref": "#/components/responses/PatchEntity_400" }, "412": { "$ref": "#/components/responses/PatchEntity_412" }, "404": { "$ref": "#/components/responses/PatchEntity_404" }, "422": { "description": "The PATCH method cannot be used for insertion of a record, but a header of the request specifies that the record has to be inserted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemsforWebIntegration" } } } } } } }, "/Invoices/{actionName}": { "post": { "tags": [ "Invoices" ], "summary": "Performs an action in the system.", "operationId": "Invoices_InvokeAction_CustomAction", "parameters": [ { "$ref": "#/components/parameters/actionName" } ], "requestBody": { "description": "The record to which the action should be applied and the parameters of the action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesCustomAction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InvoicesCustomAction" } } }, "required": true, "x-bodyName": "invocation" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/InvokeAction_204" }, "202": { "$ref": "#/components/responses/InvokeAction_202" }, "400": { "$ref": "#/components/responses/InvokeAction_400" }, "412": { "$ref": "#/components/responses/InvokeAction_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } } }, "/Invoices/$adHocSchema": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves the schema of custom fields of the entity from the system.", "operationId": "Invoices_GetAdHocSchema", "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The field name, view name, and type of the fields that are not defined in the contract of the endpoint for this entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } } }, "/Invoices/{ids}": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves a record by the values of its key fields from the system.", "operationId": "Invoices_GetByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "Deletes the record by the values of its key fields.", "operationId": "Invoices_DeleteByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteByKeys_204" } } } }, "/Invoices/{ids}/files/{filename}": { "put": { "tags": [ "Invoices" ], "summary": "Attaches a file to a record.", "operationId": "Invoices_PutFile", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/filename" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/PutFile_204" } } } }, "/Invoices/{id}": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves a record by the value of the session entity ID from the system.", "operationId": "Invoices_GetById", "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "Deletes the record by its session identifier.", "operationId": "Invoices_DeleteById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteById_204" } } } }, "/Invoices": { "get": { "tags": [ "Invoices" ], "summary": "Retrieves records that satisfy the specified conditions from the system.", "operationId": "Invoices_GetList", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/top" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The list of records that satisfy the specified conditions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoices" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoices" } } } } } } }, "put": { "tags": [ "Invoices" ], "summary": "Creates a record or updates an existing record.", "operationId": "Invoices_PutEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be passed to the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The created or updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } }, "400": { "$ref": "#/components/responses/PutEntity_400" }, "412": { "$ref": "#/components/responses/PutEntity_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } }, "patch": { "tags": [ "Invoices" ], "summary": "Updates the fields of an existing record that are specified in the request body.", "operationId": "Invoices_PatchEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be updated in the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } }, "400": { "$ref": "#/components/responses/PatchEntity_400" }, "412": { "$ref": "#/components/responses/PatchEntity_412" }, "404": { "$ref": "#/components/responses/PatchEntity_404" }, "422": { "description": "The PATCH method cannot be used for insertion of a record, but a header of the request specifies that the record has to be inserted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } } } }, "/CustomersforWebIntegration/{actionName}": { "post": { "tags": [ "CustomersforWebIntegration" ], "summary": "Performs an action in the system.", "operationId": "CustomersforWebIntegration_InvokeAction_CustomAction", "parameters": [ { "$ref": "#/components/parameters/actionName" } ], "requestBody": { "description": "The record to which the action should be applied and the parameters of the action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegrationCustomAction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegrationCustomAction" } } }, "required": true, "x-bodyName": "invocation" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/InvokeAction_204" }, "202": { "$ref": "#/components/responses/InvokeAction_202" }, "400": { "$ref": "#/components/responses/InvokeAction_400" }, "412": { "$ref": "#/components/responses/InvokeAction_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } } }, "/CustomersforWebIntegration/$adHocSchema": { "get": { "tags": [ "CustomersforWebIntegration" ], "summary": "Retrieves the schema of custom fields of the entity from the system.", "operationId": "CustomersforWebIntegration_GetAdHocSchema", "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The field name, view name, and type of the fields that are not defined in the contract of the endpoint for this entity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } } }, "/CustomersforWebIntegration/{ids}": { "get": { "tags": [ "CustomersforWebIntegration" ], "summary": "Retrieves a record by the values of its key fields from the system.", "operationId": "CustomersforWebIntegration_GetByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } }, "delete": { "tags": [ "CustomersforWebIntegration" ], "summary": "Deletes the record by the values of its key fields.", "operationId": "CustomersforWebIntegration_DeleteByKeys", "parameters": [ { "$ref": "#/components/parameters/ids" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteByKeys_204" } } } }, "/CustomersforWebIntegration/{ids}/files/{filename}": { "put": { "tags": [ "CustomersforWebIntegration" ], "summary": "Attaches a file to a record.", "operationId": "CustomersforWebIntegration_PutFile", "parameters": [ { "$ref": "#/components/parameters/ids" }, { "$ref": "#/components/parameters/filename" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/PutFile_204" } } } }, "/CustomersforWebIntegration/{id}": { "get": { "tags": [ "CustomersforWebIntegration" ], "summary": "Retrieves a record by the value of the session entity ID from the system.", "operationId": "CustomersforWebIntegration_GetById", "parameters": [ { "$ref": "#/components/parameters/id" }, { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The requested record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } }, "delete": { "tags": [ "CustomersforWebIntegration" ], "summary": "Deletes the record by its session identifier.", "operationId": "CustomersforWebIntegration_DeleteById", "parameters": [ { "$ref": "#/components/parameters/id" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "204": { "$ref": "#/components/responses/DeleteById_204" } } } }, "/CustomersforWebIntegration": { "get": { "tags": [ "CustomersforWebIntegration" ], "summary": "Retrieves records that satisfy the specified conditions from the system.", "operationId": "CustomersforWebIntegration_GetList", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" }, { "$ref": "#/components/parameters/skip" }, { "$ref": "#/components/parameters/top" } ], "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The list of records that satisfy the specified conditions.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } } }, "put": { "tags": [ "CustomersforWebIntegration" ], "summary": "Creates a record or updates an existing record.", "operationId": "CustomersforWebIntegration_PutEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be passed to the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The created or updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } }, "400": { "$ref": "#/components/responses/PutEntity_400" }, "412": { "$ref": "#/components/responses/PutEntity_412" }, "422": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } }, "patch": { "tags": [ "CustomersforWebIntegration" ], "summary": "Updates the fields of an existing record that are specified in the request body.", "operationId": "CustomersforWebIntegration_PatchEntity", "parameters": [ { "$ref": "#/components/parameters/select" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/expand" }, { "$ref": "#/components/parameters/custom" } ], "requestBody": { "description": "The record to be updated in the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } }, "required": true, "x-bodyName": "entity" }, "responses": { "401": { "$ref": "#/components/responses/ContractBasedControllerBase_401" }, "500": { "$ref": "#/components/responses/ContractBasedControllerBase_500" }, "200": { "description": "The updated record.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } }, "400": { "$ref": "#/components/responses/PatchEntity_400" }, "412": { "$ref": "#/components/responses/PatchEntity_412" }, "404": { "$ref": "#/components/responses/PatchEntity_404" }, "422": { "description": "The PATCH method cannot be used for insertion of a record, but a header of the request specifies that the record has to be inserted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomersforWebIntegration" } } } } } } } }, "components": { "schemas": { "BooleanValue": { "type": "object", "properties": { "value": { "type": "boolean", "nullable": true }, "error": { "type": "string" } } }, "ByteValue": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string" } } }, "CustomBooleanField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "boolean" }, "error": { "type": "string" } } } ] }, "CustomByteField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "error": { "type": "string" } } } ] }, "CustomDateTimeField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "string", "format": "date-time" }, "error": { "type": "string" } } } ] }, "CustomDecimalField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "error": { "type": "string" } } } ] }, "CustomDoubleField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "error": { "type": "string" } } } ] }, "CustomField": { "required": [ "type" ], "type": "object", "properties": { "type": { "type": "string" } }, "discriminator": { "propertyName": "type" } }, "CustomGuidField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "string", "format": "uuid" }, "error": { "type": "string" } } } ] }, "CustomIntField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "error": { "type": "string" } } } ] }, "CustomLongField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int64" }, "error": { "type": "string" } } } ] }, "CustomShortField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "error": { "type": "string" } } } ] }, "CustomStringField": { "allOf": [ { "$ref": "#/components/schemas/CustomField" }, { "type": "object", "properties": { "value": { "type": "string" }, "error": { "type": "string" } } } ] }, "CustomersExport": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "CustomerID": { "$ref": "#/components/schemas/StringValue" }, "CustomerName": { "$ref": "#/components/schemas/StringValue" }, "ViewonWeb": { "$ref": "#/components/schemas/StringValue" } } } ] }, "CustomersforWebIntegration": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "CustomersforWebIntegrationDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CustomersforWebIntegrationDetail" } }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/CustomersExport" } } } } ] }, "CustomersforWebIntegrationCustomAction": { "required": [ "entity" ], "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/CustomersforWebIntegration" }, "parameters": { "type": "object", "properties": { "custom": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomField" } } } }, "description": "The parameters of the action." } } }, "CustomersforWebIntegrationDetail": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "ViewonWeb": { "$ref": "#/components/schemas/StringValue" }, "CustomerID": { "$ref": "#/components/schemas/StringValue" }, "CustomerName": { "$ref": "#/components/schemas/StringValue" } } } ] }, "DateTimeValue": { "type": "object", "properties": { "value": { "type": "string", "format": "date-time", "nullable": true }, "error": { "type": "string" } } }, "DecimalValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "error": { "type": "string" } } }, "DoubleValue": { "type": "object", "properties": { "value": { "type": "number", "format": "double", "nullable": true }, "error": { "type": "string" } } }, "Entity": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "rowNumber": { "type": "integer", "format": "int64" }, "note": { "$ref": "#/components/schemas/StringValue" }, "custom": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomField" } } }, "error": { "type": "string" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FileLink" } }, "_links": { "type": "object", "additionalProperties": { "type": "string", "format": "uri" } } } }, "FileLink": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "filename": { "type": "string" }, "href": { "type": "string", "format": "uri" }, "comment": { "type": "string", "nullable": true } } }, "GuidValue": { "type": "object", "properties": { "value": { "type": "string", "format": "uuid", "nullable": true }, "error": { "type": "string" } } }, "HttpError": { "type": "object", "properties": { "message": { "type": "string" }, "exceptionMessage": { "type": "string", "nullable": true }, "exceptionType": { "type": "string", "nullable": true }, "stackTrace": { "type": "string", "nullable": true }, "modelState": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "messageDetail": { "type": "string" } }, "additionalProperties": { "type": "object" } }, "IntValue": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string" } } }, "InvoiceDetail": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "Account": { "$ref": "#/components/schemas/StringValue" }, "DescriptionAccountID_Account_description": { "$ref": "#/components/schemas/StringValue" }, "EntityUsageType": { "$ref": "#/components/schemas/StringValue" }, "BaseQty": { "$ref": "#/components/schemas/DecimalValue" }, "Branch": { "$ref": "#/components/schemas/StringValue" }, "CaseID": { "$ref": "#/components/schemas/StringValue" }, "Commissionable": { "$ref": "#/components/schemas/BooleanValue" }, "CostBasedOn": { "$ref": "#/components/schemas/StringValue" }, "CostCode": { "$ref": "#/components/schemas/StringValue" }, "CostAccrual": { "$ref": "#/components/schemas/DecimalValue" }, "CashDiscountBalance": { "$ref": "#/components/schemas/DecimalValue" }, "DiscountAmount": { "$ref": "#/components/schemas/DecimalValue" }, "ExtPrice": { "$ref": "#/components/schemas/DecimalValue" }, "TaxAmount": { "$ref": "#/components/schemas/DecimalValue" }, "CuryRetainageAmt": { "$ref": "#/components/schemas/DecimalValue" }, "UnreleasedRetention": { "$ref": "#/components/schemas/DecimalValue" }, "RetainedTax": { "$ref": "#/components/schemas/DecimalValue" }, "LineNbrLineNbr": { "$ref": "#/components/schemas/IntValue" }, "InventoryID": { "$ref": "#/components/schemas/StringValue" }, "ReferenceNbr": { "$ref": "#/components/schemas/StringValue" }, "TransactionDescr": { "$ref": "#/components/schemas/StringValue" }, "UOM": { "$ref": "#/components/schemas/StringValue" }, "UnitPrice": { "$ref": "#/components/schemas/DecimalValue" }, "Amount": { "$ref": "#/components/schemas/DecimalValue" }, "TaxCategory": { "$ref": "#/components/schemas/StringValue" } } } ] }, "Invoices": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "Details": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceDetail" } }, "DiscountTotal": { "$ref": "#/components/schemas/DecimalValue" }, "BalanceCuryDocBal": { "$ref": "#/components/schemas/DecimalValue" }, "Currency": { "$ref": "#/components/schemas/StringValue" }, "BalanceCuryInitDocBal": { "$ref": "#/components/schemas/DecimalValue" }, "DetailTotal": { "$ref": "#/components/schemas/DecimalValue" }, "PromptPaymentDisc": { "$ref": "#/components/schemas/DecimalValue" }, "Amount": { "$ref": "#/components/schemas/DecimalValue" }, "RoundingDiff": { "$ref": "#/components/schemas/DecimalValue" }, "TaxTotal": { "$ref": "#/components/schemas/DecimalValue" }, "GSTExemptTotal": { "$ref": "#/components/schemas/DecimalValue" }, "GSTTaxableTotal": { "$ref": "#/components/schemas/DecimalValue" }, "CuryViewState": { "$ref": "#/components/schemas/BooleanValue" }, "Customer": { "$ref": "#/components/schemas/StringValue" }, "Location": { "$ref": "#/components/schemas/StringValue" }, "PromptPaymentDiscDate": { "$ref": "#/components/schemas/DateTimeValue" }, "Date": { "$ref": "#/components/schemas/DateTimeValue" }, "Description": { "$ref": "#/components/schemas/StringValue" }, "Type": { "$ref": "#/components/schemas/StringValue" }, "DueDate": { "$ref": "#/components/schemas/DateTimeValue" }, "PostPeriod": { "$ref": "#/components/schemas/StringValue" }, "CustomerOrderNbr": { "$ref": "#/components/schemas/StringValue" }, "RetentionDocument": { "$ref": "#/components/schemas/BooleanValue" }, "PaybyLine": { "$ref": "#/components/schemas/BooleanValue" }, "ProjectContract": { "$ref": "#/components/schemas/StringValue" }, "ReferenceNbr": { "$ref": "#/components/schemas/StringValue" }, "ApplyRetention": { "$ref": "#/components/schemas/BooleanValue" }, "Status": { "$ref": "#/components/schemas/StringValue" }, "Terms": { "$ref": "#/components/schemas/StringValue" }, "FTSReference": { "$ref": "#/components/schemas/StringValue" } } } ] }, "InvoicesCustomAction": { "required": [ "entity" ], "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/Invoices" }, "parameters": { "type": "object", "properties": { "custom": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomField" } } } }, "description": "The parameters of the action." } } }, "ItemEx2": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "InventoryID": { "$ref": "#/components/schemas/StringValue" }, "Description": { "$ref": "#/components/schemas/StringValue" }, "ViewonWeb": { "$ref": "#/components/schemas/StringValue" } } } ] }, "ItemsExport": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "InventoryID": { "$ref": "#/components/schemas/StringValue" }, "Description": { "$ref": "#/components/schemas/StringValue" }, "ViewonWeb": { "$ref": "#/components/schemas/StringValue" } } } ] }, "ItemsforWebIntegration": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "ItemsforWebIntegrationDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsforWebIntegrationDetail" } }, "Results": { "type": "array", "items": { "$ref": "#/components/schemas/ItemsExport" } }, "Results2": { "type": "array", "items": { "$ref": "#/components/schemas/ItemEx2" } } } } ] }, "ItemsforWebIntegrationCustomAction": { "required": [ "entity" ], "type": "object", "properties": { "entity": { "$ref": "#/components/schemas/ItemsforWebIntegration" }, "parameters": { "type": "object", "properties": { "custom": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomField" } } } }, "description": "The parameters of the action." } } }, "ItemsforWebIntegrationDetail": { "allOf": [ { "$ref": "#/components/schemas/Entity" }, { "type": "object", "properties": { "ViewonWeb": { "$ref": "#/components/schemas/StringValue" }, "InventoryID": { "$ref": "#/components/schemas/StringValue" }, "Description": { "$ref": "#/components/schemas/StringValue" } } } ] }, "LongValue": { "type": "object", "properties": { "value": { "type": "integer", "format": "int64", "nullable": true }, "error": { "type": "string" } } }, "ShortValue": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32", "nullable": true }, "error": { "type": "string" } } }, "StringValue": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "error": { "type": "string" } } } }, "responses": { "ContractBasedControllerBase_401": { "description": "The user is not logged in to the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "ContractBasedControllerBase_500": { "description": "Internal server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "InvokeAction_204": { "description": "The operation that was initiated by the action is completed.", "headers": { "Location": { "description": "A URL that can be used to obtain the processed entity through the GET HTTP method.", "schema": { "type": "string", "format": "uri" } } } }, "InvokeAction_202": { "description": "The operation is in progress.", "headers": { "Location": { "description": "A URL that can be used to check the status of the operation through the GET HTTP method.", "schema": { "type": "string", "format": "uri" } } } }, "InvokeAction_400": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "InvokeAction_412": { "description": "Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "DeleteByKeys_204": { "description": "The record is successfully deleted." }, "PutFile_204": { "description": "The file is successfully attached.", "headers": { "Location": { "description": "A URL that can be used to retrieve the file from the system.", "schema": { "type": "string", "format": "uri" } } } }, "DeleteById_204": { "description": "The record is successfully deleted." }, "PutEntity_400": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "PutEntity_412": { "description": "Either the header of the request specifies that the entity has to be inserted but an entity with these keys already exists in the database and cannot be inserted, or the header specifies that the entity has to be updated but there is no entity with these keys in the database.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "PatchEntity_400": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "PatchEntity_412": { "description": "The PATCH method cannot be used for insertion of a record, but a header of the request specifies that the record has to be inserted.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "PatchEntity_404": { "description": "The specified record cannot be found in the system.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } }, "StartReport_202": { "description": "The operation is in progress.", "headers": { "Location": { "description": "A URL that can be used to check the status of the operation through the GET HTTP method.", "schema": { "type": "string", "format": "uri" } } } }, "StartReport_400": { "description": "The data specified in the request is invalid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpError" } }, "text/json": { "schema": { "$ref": "#/components/schemas/HttpError" } } } } }, "parameters": { "actionName": { "name": "actionName", "in": "path", "required": true, "schema": { "type": "string" } }, "ids": { "name": "ids", "in": "path", "description": "The values of the key fields of the record. The values are slash-delimited.", "required": true, "schema": { "type": "string" } }, "select": { "name": "$select", "in": "query", "description": "The fields of the entity to be returned from the system.", "schema": { "type": "string" } }, "filter": { "name": "$filter", "in": "query", "description": "The conditions that determine which records should be selected from the system.", "schema": { "type": "string" } }, "expand": { "name": "$expand", "in": "query", "description": "The linked and detail entities that should be expanded.", "schema": { "type": "string" } }, "custom": { "name": "$custom", "in": "query", "description": "The fields that are not defined in the contract of the endpoint to be returned from the system.", "schema": { "type": "string" } }, "filename": { "name": "filename", "in": "path", "description": "The name of the file that you are going to attach with the extension.", "required": true, "schema": { "type": "string" } }, "id": { "name": "id", "in": "path", "description": "The session ID of the record.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "skip": { "name": "$skip", "in": "query", "description": "The number of records to be skipped from the list of returned records.", "schema": { "type": "integer", "format": "int32" } }, "top": { "name": "$top", "in": "query", "description": "The number of records to be returned from the system.", "schema": { "type": "integer", "format": "int32" } } } }, "tags": [ { "name": "CustomersforWebIntegration", "description": "Customers for Web Integration (GI640592)" }, { "name": "Invoices", "description": "(AR301000)" }, { "name": "ItemsforWebIntegration", "description": "(GICF0003)" } ] }