@itentialopensource/adapter-scansource

{ "openapi": "3.0.0", "info": { "title": "APIs", "contact": {}, "version": "v1-2" }, "servers": [ { "url": "https://webapitest.scansource.com", "variables": {} } ], "paths": { "/address/{collectionKey}/{addressId}": { "get": { "tags": [ "Address" ], "summary": "Address_GetAddress", "description": "Returns address for a given address Id", "operationId": "Address_GetAddress", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address Collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "description": "Optional Address id", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponseModel" } } } } }, "deprecated": false }, "delete": { "tags": [ "Address" ], "summary": "Address_Delete", "description": "Delete Address", "operationId": "Address_Delete", "parameters": [ { "name": "collectionKey", "in": "path", "description": "collection Key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "description": "Id of address to delete", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/address/exists/{collectionKey}": { "get": { "tags": [ "Address" ], "summary": "Address_Exists", "description": "Determines if collection exists and contains addresses", "operationId": "Address_Exists", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address collection key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "boolean", "description": "OK" } } } } }, "deprecated": false } }, "/address/{collectionKey}": { "put": { "tags": [ "Address" ], "summary": "Address_UpdateAddress", "description": "Update address in collection", "operationId": "Address_UpdateAddress", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address collection key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Address model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpdateModel" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false }, "post": { "tags": [ "Address" ], "summary": "Address_AddAddress", "description": "Create new address in collection\r\nCreates new collection if one does not exist", "operationId": "Address_AddAddress", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address collection key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Address model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "integer", "description": "OK", "format": "int32" } } } } }, "deprecated": false } }, "/address/copy/{collectionKey}/{AddressId}": { "post": { "tags": [ "Address" ], "summary": "Address_CopyAddress", "description": "Copy existing address to new address", "operationId": "Address_CopyAddress", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "AddressId", "in": "path", "description": "Id of Address to copy", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "integer", "description": "OK", "format": "int32" } } } } }, "deprecated": false } }, "/address/clear/{collectionKey}": { "delete": { "tags": [ "Address" ], "summary": "Address_Clear", "description": "Delete all addresses in collection", "operationId": "Address_Clear", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Region", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/address/move/{sourceCollectionKey}/{destinationCollectionKey}/{addressId}": { "post": { "tags": [ "Address" ], "summary": "Address_MoveAddress", "description": "Moves an address from one collection to another.", "operationId": "Address_MoveAddress", "parameters": [ { "name": "sourceCollectionKey", "in": "path", "description": "Source collection to move from", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "destinationCollectionKey", "in": "path", "description": "Destination collection", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "addressId", "in": "path", "description": "Address Id to move", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/address/search/{collectionKey}": { "get": { "tags": [ "Address" ], "summary": "Address_Search", "description": "Search for addresses in collection", "operationId": "Address_Search", "parameters": [ { "name": "collectionKey", "in": "path", "description": "Address collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page number", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of results per page", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Optional search by address name", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "stateProvince", "in": "query", "description": "Optional search by state/province", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "description": "Optional search by postal code", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "countryCode", "in": "query", "description": "Optional search by country code", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Full text search against all address fields - overrides other search parameters", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "useAndOperator", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressResponseModel" }, "description": "OK" } } } } }, "deprecated": false } }, "/address/countries/{region}": { "get": { "tags": [ "Address" ], "summary": "Address_GetAddressCountries", "description": "Get Countries codes and validation pattern for a given region", "operationId": "Address_GetAddressCountries", "parameters": [ { "name": "region", "in": "path", "description": "Specifies Region (North America - 0, Europe - 1, Latin America - 2)", "required": true, "style": "simple", "schema": { "$ref": "#/components/schemas/region2" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressCountry" }, "description": "OK" } } } } }, "deprecated": false } }, "/address/provinces/{countryCode}": { "get": { "tags": [ "Address" ], "summary": "Address_GetAddressProvinceStates", "description": "Get provinces / state codes for given countryCode", "operationId": "Address_GetAddressProvinceStates", "parameters": [ { "name": "countryCode", "in": "path", "description": "Standard ISO-3166 2-Character country code", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressProvinceState" }, "description": "OK" } } } } }, "deprecated": false } }, "/address/validate": { "post": { "tags": [ "Address" ], "summary": "Address_Validate", "description": "Validate address", "operationId": "Address_Validate", "parameters": [], "requestBody": { "description": "Address model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressValidationResponse" } } } } }, "deprecated": false } }, "/cart/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "summary": "Cart_GetCart", "description": "Returns current cart for the given cartCollectionKey\r\noptional id returns cart specified in cart collection", "operationId": "Cart_GetCart", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Optional cart id", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartResponse" } } } } }, "deprecated": false }, "put": { "tags": [ "Cart" ], "summary": "Cart_UpdateCart", "description": "Update cart in cart collection", "operationId": "Cart_UpdateCart", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "updateCartItems", "in": "query", "description": "", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "requestBody": { "description": "Cart model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartUpdateModel" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false }, "post": { "tags": [ "Cart" ], "summary": "Cart_AddCart", "description": "Create new cart in cart collection, optionally set as current cart\r\nCreates new cart collection if one does not exist", "operationId": "Cart_AddCart", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "currentCart", "in": "query", "description": "Flag indicating if new cart should become current cart for collection", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "requestBody": { "description": "Cart model", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "integer", "description": "OK", "format": "int32" } } } } }, "deprecated": false }, "delete": { "tags": [ "Cart" ], "summary": "Cart_Delete", "description": "Delete current cart or specific cart", "operationId": "Cart_Delete", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Collection Key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Optional Cart ID", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/exists/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "summary": "Cart_Exists", "description": "Determines if cart collection exists and contains carts", "operationId": "Cart_Exists", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "boolean", "description": "OK" } } } } }, "deprecated": false } }, "/cart/copy/{cartCollectionKey}/{cartId}": { "post": { "tags": [ "Cart" ], "summary": "Cart_CopyCart", "description": "Copy existing cart to new cart \r\nOptionally set new cart as current cart", "operationId": "Cart_CopyCart", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "path", "description": "Id of cart to copy", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "currentCart", "in": "query", "description": "Flag indicating if new cart should become current cart for collection", "style": "form", "explode": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "integer", "description": "OK", "format": "int32" } } } } }, "deprecated": false } }, "/cart/list/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "summary": "Cart_GetCartList", "description": "Returns an array of carts contained by the collection matching the received \"cartCollectionKey\".\r\nThis method can be used for client applications to display a list of carts for the user to select\r\nas their current cart for systems which allow multiple carts per user.", "operationId": "Cart_GetCartList", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Optional filter by name of cart", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartListResponse" } } } } }, "deprecated": false } }, "/cart/item/{cartCollectionKey}": { "post": { "tags": [ "Cart" ], "summary": "Cart_AddItem", "description": "Add cart item to current cart or specified cartId", "operationId": "Cart_AddItem", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Collection Key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Optional cart id", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "cart item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartItemModel" } } }, "required": true }, "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "integer", "description": "OK", "format": "int32" } } } } }, "deprecated": false } }, "/cart/item/{cartCollectionKey}/{cartId}": { "put": { "tags": [ "Cart" ], "summary": "Cart_UpdateItem", "description": "Update cart item", "operationId": "Cart_UpdateItem", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "path", "description": "Cart ID", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Cart item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartItemUpdateModel" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/item/{cartCollectionKey}/{itemId}": { "delete": { "tags": [ "Cart" ], "summary": "Cart_DeleteItem", "description": "Delete current cart item or specific cart item", "operationId": "Cart_DeleteItem", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart Collection Key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "description": "Item Id", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "cartId", "in": "query", "description": "Optional cart id", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/clear/{cartCollectionKey}": { "delete": { "tags": [ "Cart" ], "summary": "Cart_Clear", "description": "Delete all carts in cart collection", "operationId": "Cart_Clear", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Collection Key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/hascurrent/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "summary": "Cart_HasCurrent", "description": "Indicates if cart collection has current cart", "operationId": "Cart_HasCurrent", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Collection Key", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "boolean", "description": "OK" } } } } }, "deprecated": false } }, "/cart/switch/{cartCollectionKey}/{cartId}": { "put": { "tags": [ "Cart" ], "summary": "Cart_SwitchCurrentCart", "description": "For client applications which allow multiple carts per user, provides a way to switch what is\r\nconsidered the user's current cart to the cart matching the given cartID.", "operationId": "Cart_SwitchCurrentCart", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "path", "description": "Id of cart to make current cart", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/move/{sourceCollectionKey}/{destinationCollectionKey}/{cartId}": { "post": { "tags": [ "Cart" ], "summary": "Cart_MoveCart", "description": "Moves a cart from one collection to another. This could be used by a caller for many\r\npurposes such as providing a way to move a cart from one user to another, or to\r\nprovide the server-side implementation of an approval queue by creating a collectionKey\r\nfor the queue, and moving the cart to the queue collection upon submission.", "operationId": "Cart_MoveCart", "parameters": [ { "name": "sourceCollectionKey", "in": "path", "description": "Source collection to move from", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "destinationCollectionKey", "in": "path", "description": "Destination collection", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "path", "description": "Cart Id", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/cart/checkoutinfo/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "summary": "Cart_GetCheckoutInfo", "description": "Get checkout info from current cart or specified cart by cartId", "operationId": "Cart_GetCheckoutInfo", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Optional cart id", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartCheckoutInfoModel" } } } } }, "deprecated": false }, "post": { "tags": [ "Cart" ], "summary": "Cart_SaveCheckoutInfo", "description": "Add or update checkout info to current cart or cart specified by cartId", "operationId": "Cart_SaveCheckoutInfo", "parameters": [ { "name": "cartCollectionKey", "in": "path", "description": "Cart collection key", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "cartId", "in": "query", "description": "Optional cart id", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Checkout state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CartCheckoutInfoModel" } } }, "required": true }, "responses": { "204": { "description": "No Content", "headers": {} } }, "deprecated": false } }, "/ciscodart/summary": { "get": { "tags": [ "CiscoDart" ], "summary": "CiscoDart_GetSummary", "description": "Cisco Dart summary", "operationId": "CiscoDart_GetSummary", "parameters": [ { "name": "customerNumber", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CiscoDart" }, "description": "OK" } } } } }, "deprecated": false } }, "/ciscodart/detail": { "get": { "tags": [ "CiscoDart" ], "summary": "CiscoDart_GetDetail", "description": "Cisco Dart detail", "operationId": "CiscoDart_GetDetail", "parameters": [ { "name": "dealId", "in": "query", "description": "", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CiscoDartDetail" } } } } }, "deprecated": false } }, "/customconfig/list": { "get": { "tags": [ "CustomConfig" ], "summary": "CustomConfig_GetCustomConfigs", "description": "Get list of custom configurations", "operationId": "CustomConfig_GetCustomConfigs", "parameters": [ { "name": "customerNumber", "in": "query", "description": "Your customer number", "required": true, "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomConfig" }, "description": "OK" } } } } }, "deprecated": false } }, "/customer/creditdata/{customerNumber}/{region}": { "get": { "tags": [ "Customer" ], "summary": "Customer_GetCustCreditData", "description": "Returns customer status, revenue, credit limit, for a given customer", "operationId": "Customer_GetCustCreditData", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Customer Number", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "region", "in": "path", "description": "Region", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustCreditDataResponse" }, "description": "OK" } } } } }, "deprecated": false } }, "/customer/payers/{customerNumber}/{businessUnit}": { "get": { "tags": [ "Customer" ], "summary": "Customer_GetPayers", "description": "Returns list of payers for a given customer", "operationId": "Customer_GetPayers", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Your Customer Number", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "businessUnit", "in": "path", "description": "Specify business unit that you will be purchasing from\r\n \r\n 1712 – ScanSource POS / Barcode\r\n \r\n 1713 – ScanSource Catalyst\r\n \r\n 1714 – ScanSource Communications\r\n \r\n 1715 – ScanSource Security\r\n \r\n 1718 – ScanSource Networking\r\n \r\n 2512 – ScanSource EU POS / Barcode\r\n \r\n 2514 – ScanSource EU Communications", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayerResponse" } } } } }, "deprecated": false } }, "/invoice/summary/{customerNumber}": { "get": { "tags": [ "Invoice" ], "summary": "Invoice_GetInvoiceSummary", "description": "Get Invoice Summary allows customers to get a paged list of invoices.\r\nSearch parameters can be specified to search by serial numbers and mac addresses within a given date range", "operationId": "Invoice_GetInvoiceSummary", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Your Customer Number", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page Number", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of results per page", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "salesOrderNumber", "in": "query", "description": "Sales Order Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "query", "description": "Invoice Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "poNumber", "in": "query", "description": "Purchase Order Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "Start date range", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "End date range", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceSummary" }, "description": "OK" } } } } }, "deprecated": false } }, "/invoice/list/{customerNumber}": { "get": { "tags": [ "Invoice" ], "summary": "Invoice_GetInvoiceList", "description": "Get Invoice List allows customers to get a paged list of invoices with details.", "operationId": "Invoice_GetInvoiceList", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Your Customer Number", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Page Number", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of results per page", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "salesOrderNumber", "in": "query", "description": "Sales Order Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "query", "description": "Invoice Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "poNumber", "in": "query", "description": "Purchase Order Number", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "Start date range", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "End date range", "style": "form", "explode": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": {}, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceList" }, "description": "OK" } } } } }, "deprecated": false } }, "/invoice/detail/{customerNumber}/{invoiceNumber}": { "get": { "tags": [ "Invoice" ], "summary": "Invoice_GetInvoiceDetail", "description": "Invoice Detail - returns details abou