ASP.NET Web API Help Page

Introduction

Tula ERP Api. Automating Dynamics and Replacing some features of Dynamics.

Client

Client controller for managing clients. You can view and edit. You should not be able to add

API	Description
GET api/v1/Clients?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get a list of clients with paging
GET api/v1/Client/name/{clientName}	Get a client by name
GET api/v1/Client/{Id}	Get a client by id
GET api/v1/Client/{clientId}/Contract/{id}	Get a client contract by client and contract id
POST api/v1/Client/{id}/Contract	Add a client contract
PUT api/v1/Client	Update a client. There is no add
PUT api/v1/Client/{id}/Contract	Update a client contract

Items

Item management. New items should come from the ERP system. (Dynamics)

API	Description
GET api/v1/Items?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Gets a list of items based on the parameters passed in.
GET api/v1/Items/ItemCode/{itemCode}	No documentation available.
GET api/v1/Items/{id}
POST api/v1/Items	No documentation available.

Warehouse

API	Description
GET api/v1/Warehouses?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	No documentation available.
GET api/v1/Warehouses/name/{warehouseName}	No documentation available.
GET api/v1/Warehouses/{Id}	No documentation available.
POST api/v1/Warehouses	No documentation available.
DELETE api/v1/Warehouses	No documentation available.
PUT api/v1/Warehouses	No documentation available.

Security

API	Description
GET api/v1/security/users?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	No documentation available.

API

Description

GET api/v1/security/users?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}

No documentation available.

OrderTemplate

Order Template Controller for order template managment. These are templates that can be used to create future orders.

API	Description
GET api/v1/Orders/Templates/{id}
POST api/v1/Orders/Templates	Order Template
POST api/v1/Orders/Replenishment/{memberNumber}/{itemCode}
PUT api/v1/Orders/Templates	Update the order template from a previous version

Members

All Tula member related operations on the ERP system

API	Description
GET api/v1/Members?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get a list of members. Use "all" as clientname to ignore client
GET api/v1/Members/{id}?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get a member by unique number
GET api/v1/Members/ById/{id}	Get a member by id
GET api/v1/Members/ByDetails/{clientName}/{firstName}/{lastName}/{DOB}	No documentation available.
POST api/v1/Members	Update a member or Add a member to the database. If the member has an id, it will be updated. If the member does not have an id, it will be added.
POST api/v1/Members/setbillable/{Id}?acceptDT={acceptDT}	Shortcut to mark a member as billable
POST api/v1/Members/optout/{Id}?optOutDt={optOutDt}	Shortcut to mark a member as opted out
PUT api/v1/Members/update	Update a member If the member has an id, it will be updated. If the member does not have an id, it will be added.
PUT api/v1/Members	No documentation available.
DELETE api/v1/Members/{Id}?cancelDT={cancelDT}	No documentation available.
POST api/v1/Members/MarkAsIneligible	No documentation available.
POST api/v1/Members/Test/UpdateCalls/{memberUniqueKey}	No documentation available.

Invoices

Controller for managing invoices

API	Description
GET api/v1/Invoices?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}
GET api/v1/Invoices/{id}

Inventory

Inventory Methods for Supply Chain

API	Description
GET api/v1/ItemInventory?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get many inventory records
GET api/v1/ItemInventory/{id}	Get an inventory record by id number
GET api/v1/ItemInventory/itemCode/{itemCode}	Get Item by item code
GET api/v1/ItemInventory/Receive?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get all receiving events
POST api/v1/ItemInventory/Adjust	Adjust inevnetory
POST api/v1/ItemInventory/Receive	Receive Inventory

AI

API	Description
GET api/v1/ai/members/recommendations/{memberUniqueKey}	No documentation available.
POST api/v1/ai/members/recommendations/{memberUniqueKey}	No documentation available.

BillingEvent

Billing Events. You can see a list, see one, add one at a time. Billing events are tied to members and invoices.

API	Description
GET api/v1/BillingEvents?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	Get many billing events by parameters
GET api/v1/BillingEvents/{bGuid}	Get a single billing event
POST api/v1/BillingEvents/{clientName}	Post a billing event
POST api/v1/BillingEvents/member/{memberGuid}	Post a billing event to a member
POST api/v1/BillingEvents/member/{memberGuid}/{billingEventType}	Post a new billing event by type

Dashboard

Dashboard controller

API	Description
GET api/v1/Dashboard/OpenOrders?ClientName={ClientName}&StartDate={StartDate}&EndDate={EndDate}&NextPage={NextPage}&PageSize={PageSize}&FilterBy={FilterBy}&ReportType={ReportType}	Get Open Order Count
GET api/v1/Dashboard/OrdersRange?ClientName={ClientName}&StartDate={StartDate}&EndDate={EndDate}&NextPage={NextPage}&PageSize={PageSize}&FilterBy={FilterBy}&ReportType={ReportType}	Orders Range by week
GET api/v1/Dashboard/OpenInvoiceCount?ClientName={ClientName}&StartDate={StartDate}&EndDate={EndDate}&NextPage={NextPage}&PageSize={PageSize}&FilterBy={FilterBy}&ReportType={ReportType}	Get Open Invoice Count
GET api/v1/Dashboard/BillableMembersRange?ClientName={ClientName}&StartDate={StartDate}&EndDate={EndDate}&NextPage={NextPage}&PageSize={PageSize}&FilterBy={FilterBy}&ReportType={ReportType}	Billable Members in Range

SupplyChain

Supply Chain Controller. Endpoints needed for Supply Chain Management

API	Description
POST api/v1/SupplyChain/KitBuild	No documentation available.

Orders

These are orders that are created from templates or by themselves.

API	Description
GET api/v1/Orders?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}
GET api/v1/Orders/OrderNumber/{orderNumber}
GET api/v1/Orders/ShortOrderNumber/{shortOrderNumber}
GET api/v1/Orders/{id}
GET api/v1/Orders/ByMember/{memberUID}	Get Orders for the member
POST api/v1/Orders	Post a template order for a member.
POST api/v1/Orders/InstantReplenishment/{memberNumber}/{reasonCode}
GET api/v1/Orders/ReplenishmentEligible/{memberNumber}	Should return Eligible or NotEligible
GET api/v1/Orders/ReplenishmentEligible/{memberNumber}/ForceEligible	Should return Eligible or NotEligible
POST api/v1/Orders/WelcomeKit/{memberNumber}/{itemCode}
POST api/v1/Orders/WelcomeKitReplacement/{memberNumber}/{itemCode}
POST api/v1/Orders/Replacement/{memberNumber}/{itemCode}
POST api/v1/Orders/Tracking/{orderNumber}?memberNumber={memberNumber}&itemCode={itemCode}
POST api/v1/Tracking/{trackingNumber}?memberNumber={memberNumber}&itemCode={itemCode}	No documentation available.
DELETE api/v1/Orders/{id}	No documentation available.

Fulfillment

Fulfillment Controller for our applications

API	Description
GET api/v1/Fulfillment?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	No documentation available.
POST api/v1/Fulfillment/Job	No documentation available.
GET api/v1/Fulfillment/Job/{Id}	No documentation available.
POST api/v1/Fulfillment/Job/Complete/{id}	No documentation available.
PUT api/v1/Fulfillment/Job	No documentation available.
GET api/v1/Fulfillment/Jobs?ClientName={ClientName}&PageNumber={PageNumber}&TotalPages={TotalPages}&Status={Status}&StartDate={StartDate}&EndDate={EndDate}&IsActive={IsActive}&OrderByDesc={OrderByDesc}&OrderByModifiedDateTime={OrderByModifiedDateTime}&FilterBy={FilterBy}&SearchBy={SearchBy}&SearchCriteria={SearchCriteria}&IncludeAllChildren={IncludeAllChildren}&MemberUID={MemberUID}&PageSize={PageSize}	No documentation available.
DELETE api/v1/Fulfillment/Job/{id}	No documentation available.
GET api/v1/Fulfillment/OrderShipment/{id}	No documentation available.
GET api/v1/Fulfillment/OrderShipmentByNumber/{shortOrderNumber}	No documentation available.
PUT api/v1/Fulfillment/OrderShipment	No documentation available.