AccountsReceivable
| API | Description |
|---|---|
| GET api/v2/AR/CustomerARInquiry?CustomerId={CustomerId}&InvoiceDate={InvoiceDate} |
Retrieves A/R information and open invoices for a single customer or all customers. |
| GET api/v2/AR/CustomerPaymentHistory?CustomerId={CustomerId}&PendingOnly={PendingOnly} |
Retrieves a customers payment history. |
| POST api/v2/AR/ApplyCreditMemo |
Apply a Credit Memo to one or more invoices. |
| POST api/v2/AR/CreateMiscARCharge |
Create and post a new non taxable Miscellaneous A/R Charge or Convenience Fee. |
| POST api/v2/AR/RetrieveInvoices |
Retrieves a list of A/R Invoices. |
| POST api/v2/AR/ReversePayment |
Reverses a previously submitted payment. |
| POST api/v2/AR/SubmitBatch |
Submits a Batch of Cash Receipts to the DockMaster Cash Receipts system. |
Boats
| API | Description |
|---|---|
| GET api/v2/Boats/ListNewOrChanged?LastUpdate={LastUpdate}&Page={Page}&PageSize={PageSize}&ListName={ListName} |
Searches for Boats created or changed as of a date. Returns result for page and page size requested. |
| GET api/v2/Boats/RetrieveBoat/{BoatId} |
Retrieves a single Customer Boat record. |
| GET api/v2/Boats/RetrieveBoats?CustId={CustId}&LastUpdateDate={LastUpdateDate} |
Retrieve a list of Customer Boats. |
| POST api/v2/Boats/Search |
Search for Customer Boats based on provided criteria. |
| POST api/v2/Boats/UpdateBoat |
Create or Update a Customer Boat record. |
Customers
| API | Description |
|---|---|
| GET api/v2/Customers/List |
Returns a list of Customers with the Customer Id and Name. |
| GET api/v2/Customers/ListNewOrChanged?LastUpdate={LastUpdate}&Page={Page}&PageSize={PageSize}&ListName={ListName} |
Searches for Customers created or changed as of a date. Returns result for page and page size requested. |
| GET api/v2/Customers/RetrieveCustomer/{CustomerId} |
Retrieves a single customer record. |
| GET api/v2/Customers/RetrieveCustomers?LastModifiedDate={LastModifiedDate}&EmailAddress={EmailAddress} |
Retrieves a collection of Customer records. |
| POST api/v2/Customers/Search |
Search for Customers based on provided criteria. |
| POST api/v2/Customers/UpdateCustomer |
Create or Update a Customer record. |
General
| API | Description |
|---|---|
| GET api/v2/General/Clerks/{ClerkId} |
Retrieve a Clerk (User) record. |
| GET api/v2/General/Clerks/List?IncludeInactive={IncludeInactive} |
Retrieves a list of system Clerks (Users). |
| GET api/v2/General/Locations/{LocationCode} |
Retrieves the list of business locations. |
| GET api/v2/General/VersionInformation |
No documentation available. |
| POST api/v2/General/PayTypes/RetrievePayTypes |
Retrieves a list of Pay Types |
GeneralLedger
| API | Description |
|---|---|
| GET api/v2/GL/RetrieveJournalTransactions?BeginEffDate={BeginEffDate}&EndEffDate={EndEffDate}&PostedOnly={PostedOnly} |
Retrieves a list of Journal Transactions by effective date. |
| GET api/v2/GL/RetrievePostedJournalTransactions?BeginPostDate={BeginPostDate}&EndPostDate={EndPostDate} |
Retrieves a list of posted Journal Transactions by date range |
| POST api/v2/GL/CreateJournalTransaction |
Creates a new Journal Transaction. |
Inventory
Methods used to work with standard and fuel inventory.
| API | Description |
|---|---|
| GET api/v2/Inventory/PartsKits/List |
Retrieve a list of all Parts Kits. |
| GET api/v2/Inventory/PartsKits/{PartsKitId} |
Retrieves a Parts Kit record. |
| GET api/v2/Inventory/RetrieveFuel |
Retrieve all fuel inventory records. |
| GET api/v2/Inventory/RetrieveOnlineBillcodeList |
Retrieve a list of Billing Codes that have been selected for use online. |
| GET api/v2/Inventory/RetrieveOnlinePartsList |
Retrieve a list of inventory records that have been selected for use online. |
| GET api/v2/Inventory/RetrieveQtyInfo?ItemId={ItemId}&LocationCode={LocationCode} |
Retrieve quantity information for a specific part at a specific location. |
| GET api/v2/Inventory/RetrieveQtyInfo/ItemId/{ItemId}/LocationCode/{LocationCode} |
DEPRECATED - USE /RetrieveQtyInfo?ItemId={ItemId}&LocationCode={LocationCode} |
| GET api/v2/Inventory/SpecialOrders/CustomerSpecialOrders?CustomerId={CustomerId}&IncludeClosed={IncludeClosed} |
Retrieve a list of special orders for a specific customer. |
| GET api/v2/Inventory/SpecialOrders/ReceivedOrders?ReceivedDate={ReceivedDate}&IncludePOS={IncludePOS}&IncludeService={IncludeService} |
Retrieve a list of received special orders. |
| GET api/v2/Inventory/SpecialOrders/{SpecialOrderId} |
Retrieve a special order. |
| GET api/v2/Inventory/Vendors/List |
Retrieve a list of all vendors. |
| POST api/v2/Inventory/FindParts |
Attempts to find parts using various part numbers. Returns a list of parts records that were found. |
| POST api/v2/Inventory/Retrieve |
Retrieves inventory records from full inventory |
| POST api/v2/Inventory/Search |
Search the full inventory for an item. |
MarinaOps
| API | Description |
|---|---|
| GET api/v2/MarinaOps/Reservations/{ReservationId} |
Retrieve a Reservation. |
| GET api/v2/MarinaOps/RetrieveLaunchOperations |
Retrieve a listing of available launch operations. |
| GET api/v2/MarinaOps/RetrieveLaunchTicket/{TicketId} |
Retrieve a Launch Ticket |
| GET api/v2/MarinaOps/Slips/GetAvailableSlips?ArrivalDate={ArrivalDate}&DepartureDate={DepartureDate}&Length={Length}&Beam={Beam}&Draft={Draft} |
Get a list of slips that are available for a date range. Slip must be available for the full date range. |
| GET api/v2/MarinaOps/Slips/Retrieve?LastModifiedDate={LastModifiedDate} |
Retrieve a list of slips |
| POST api/v2/MarinaOps/QueryLaunchTickets |
Search for launch tickets base on provided criteria. |
| POST api/v2/MarinaOps/Reservations |
Create a Reservation. |
| POST api/v2/MarinaOps/Reservations/Cancel/{ReservationId} |
Cancel a Reservation |
| POST api/v2/MarinaOps/Slips/Search |
Search for slips base on provided criteria. |
| POST api/v2/MarinaOps/SubmitLaunchTicket |
Create a launch ticket. |
Orders
| API | Description |
|---|---|
| POST api/v2/Orders/RetrieveOrders |
Selects and Retrieves a collection of Orders based on supplied parameters. |
| POST api/v2/Orders/SubmitOrder |
Create or Update an Order Entry Order. |
PointOfSale
| API | Description |
|---|---|
| POST api/v2/PointOfSale/SubmitPOSTicket |
Create or Update a Point of Sale ticket. |
Prospects
| API | Description |
|---|---|
| GET api/v2/Prospects/Retrieve?ProspectId={ProspectId} |
Retrieves a single Prospect record. |
| GET api/v2/Prospects/RetrieveProspects?SalesmanId={SalesmanId}&LastUpdateDate={LastUpdateDate}&NewLeadsOnly={NewLeadsOnly}&NumbertoRetrieve={NumbertoRetrieve} |
Select and Retrieves a collection of Prospect records based on supplied parameters. |
| POST api/v2/Prospects/Search |
Search the Prospects Cross Reference. |
| POST api/v2/Prospects/UpdateProspect |
Create or Update a Prospect record. |