Estimate

APIDescription
POST v1/Estimate/EstimateInsert

Add an estimate
POST v1/Estimate/EstimateUpdate

Update an existing estimate

NexusTax

APIDescription
POST v1/NexusTax/NexusTaxList

Returns Nexus Tax List
POST v1/NexusTax/NexusTaxUpdate

Update Nexus Tax
POST v1/NexusTax/NexusTaxInsert

Allows user to add one or more nexus tax to the nexus tax record
POST v1/NexusTax/NexusTaxDelete

Allow user to delete one or more nexus tax record

Inventory

APIDescription
GET v1/Inventory/GetInventoryItem?itemId={itemId}

Retrieves the inventory item details for a given item ID.
GET v1/Inventory/GetFromLocation?itemId={itemId}

Retrieves the location details for a specific item from all locations.
GET v1/Inventory/GetLocation?locationId={locationId}&itemId={itemId}

Retrieves location details based on ItemId and LocationId. - If a specific LocationId is provided (non-zero), returns details for that location only. - If LocationId is 0, returns all locations for the given ItemId.
GET v1/Inventory/GetToLocation

Retrieves the location details for all available locations.
GET v1/Inventory/GetCustomer?customerName={customerName}

Retrieves customer details based on a partial match (LIKE statement) of the customer name.
PUT v1/Inventory/AddInventory

Adds inventory based on the provided transaction details.
PUT v1/Inventory/SubtractInventory

Subtracts inventory based on the provided transaction details.
PUT v1/Inventory/MoveInventory

Moves inventory from one location to another based on the provided transaction details.
PUT v1/Inventory/CreateInventory

Handles the operation to create inventory.
PUT v1/Inventory/ItemImageUpdate

Updates the image of an inventory item.
PUT v1/Inventory/FindInventory

Find Inventory base on either customer name, itemCode,
GET v1/Inventory/ViewInventory?itemId={itemId}

Retrieves the inventory details for a specific item.
GET v1/Inventory/ViewActiveOrders?itemId={itemId}

Retrieves a list of active orders for a specific item.
GET v1/Inventory/CheckItemCode?itemCode={itemCode}&customerId={customerId}&ItemId={ItemId}

Checks if the provided item code exists for the specified customer and item.
GET v1/Inventory/GetItemTypes?active={active}

Retrieves a list of item types based on their active status.
GET v1/Inventory/GenerateItemCode?customerId={customerId}

Generates a unique item code for a given customer.
GET v1/Inventory/ValidateOrderNumber?itemId={itemId}&orderNumber={orderNumber}

Validates the order number for a specific item.
GET v1/Inventory/GetItemLots?itemId={itemId}

Retrieves the lots associated with a specific item.
GET v1/Inventory/GetItemLocationLots?itemId={itemId}&fromLocationId={fromLocationId}

Retrieves the item location lots based on the provided item ID and from location ID.

ShipStation

APIDescription
GET v1/ShipStation?start_date={start_date}&end_date={end_date}

Returns one or more orders for ShipStation
POST v1/ShipStation

Processes shipping updates from ShipStation

Item

APIDescription
POST v1/Item/InventoryList

Get the InventoryList
POST v1/Item/WarehouseLocationList

Get Warehouse location list

Customer

APIDescription
POST v1/Customer/CustomerList

Returns Customers List
POST v1/Customer/CustomerListByCustomerID

Returns Customers List By CustomerID
POST v1/Customer/CustomerMailerIDList

Returns Customer's Mailer list
POST v1/Customer/CustomerInsert

Adds a new customer
POST v1/Customer/CustomerContactInsert

Allows the user to insert one or many customer contacts.
POST v1/Customer/CustomerContactUpdate

Allows the user to update one or many customer contacts.
POST v1/Customer/CustomerPostageAccountList

Returns the list of postage accounts for a customer
POST v1/Customer/GetCustomerDepositAccount

Returns the list of postage accounts for a customer

Order

APIDescription
POST v1/Order/OrderList

Returns one or more orders and summary information associated with each order.
POST v1/Order/EntireOrderGet

Returns an entire order.
POST v1/Order/OrderVersionUpdate

Update Order Version
POST v1/Order/OrderVersionDetailDelete

Delete Order Version Detail
POST v1/Order/OrderVersionComplete

Order Version Complete
POST v1/Order/OrderVersionPostageList

Returns list of postage used on an order version
POST v1/Order/OrderVersionPostageInsert

Adds postage used on an order version
POST v1/Order/OrderVersionDetailList

Return the list of OrderVersionDetail
POST v1/Order/OrderVersionList

Return the list of OrderVersion
POST v1/Order/OrderVersionInventoryList

Return the list of OrderVersionInventory
POST v1/Order/OrderVersionPostageUpdate

Updates order version postage information
POST v1/Order/OrderVersionPostageDetailUpdate

Updates order version postage detail information
POST v1/Order/OrderVersionDropDelete

Deletes an order version drop record
POST v1/Order/OrderVersionDetailInsert

Adds a service line item to an order version
POST v1/Order/OrderVersionDetailUpdate

Updates order version service line item information
POST v1/Order/OrderVersionDelete

Order Version Delete
POST v1/Order/OrderVersionOtherJobCostInsert

Adds the OrderVersionOtherJobCost information
POST v1/Order/OrderVersionOtherJobCostUpdate

Updates the OrderVersionOtherJobCost information
GET v1/Order/ShipStationTrackingInfo?start_date={start_date}&end_date={end_date}

Returns one or more orders for ShipStation

Invoice

APIDescription
POST v2/invoice/detail

Return details of an invoice.
POST v2/invoice/insert

Creates invoice for a customer.
POST v2/invoice/update

No documentation available.
POST v2/invoice/TaxCalculation

Calculates the tax for an invoice based on the provided request details.

DJB

APIDescription
POST v1/DJB/DJBStatusUpdate

Update DJB Status
POST v1/DJB/DJBJobStatusList

Get DJB Job Status List

Midnight

APIDescription
POST v1/Midnight/GetPaymentSurchargeInfo

Returns surcharge info for a payment based on global settings and customer surcharge settings.
GET v1/Midnight/GetAPIStatus?MISKey={MISKey}

Returns Health check info
POST v1/Midnight/CustomerPaymentInsert

Create customer payment record(s) in Midnight

Generic

APIDescription
POST v1/Generic/GetCustomerList

Get List of Customer based on the provided parameters
POST v1/Generic/CustomerPaymentInsert

Create customer payment record(s) in Midnight
POST v1/Generic/LastUsedSavedCard

Get saved card list for a customer from Midnight based on CustomerID
POST v1/Generic/CustomerSavedCardList

Get saved card list for a customer from Midnight based on CustomerID
POST v1/Generic/SavePaymentMethod

Save New Payment Card (FS Customer Payment Token Insert)
POST v1/Generic/SavePaymentMethodACH

Save New ACH Token (FS Customer Payment Token Insert)
POST v1/Generic/GetCustomerPaymentOrderList

Get List of Customer Payment Orders based on the provided parameters
GET v1/Generic/CustomerPaymentDelete?customerPaymentNumber={customerPaymentNumber}

Delete customer payment record in Midnight
POST v1/Generic/CustomerContactList

Returns Customer's Contact List
POST v1/Generic/GetCustomerAddressDetail

Get Address based on input parameters
POST v1/Generic/GetPrintReachPayTransactionDetail

Get List of PrintReach Transactions based on the provided parameters
POST v1/Generic/DeleteCustomerPaymentToken

Delete FSCustomerPaymentToken record in Midnight
POST v1/Generic/PaymentMethodList

Get saved payment method list for a customer based on CustomerID
POST v1/Generic/PaymentMethodInsert

Creates new payment method for a customer. PaymentType needs to be "Credit Card" or "ACH".
POST v1/Generic/InvoiceMethodInsert

Creates new Invoice method for a customer.
POST v1/Generic/PaymentMethodUpdate

Updates existing Payment Method for a customer
POST v1/Generic/InvoiceMethodUpdate

Updates existing Invoice Method for a customer
POST v1/Generic/PaymentMethodDelete

Deletes existing Payment Method for a customer
POST v1/Generic/GetJobsData

Get Job Details based on the provided Guid/JobID/JobNumber
POST v1/Generic/GetJobsList?customerId={customerId}

Get Active Job List
POST v1/Generic/GetJobLineItems

Get Job line items quantity values based on estimate guid (rowId)
POST v1/Generic/TermsList

Return System Terms List
POST v1/Generic/CustomerOrderList

Return all of Customer's Orders
POST v1/Generic/CustomerOrderEstPostageList

Return all of Customer's Orders
POST v1/Generic/CustomerOrderVersionList

Return all of Customer's Order version
POST v1/Generic/CustomerOrderVersionEstPostageList

Return all of Customer's Order version est Postage
POST v1/Generic/CustomerOrderSummaryList

Return all Orders of a Customer
POST v1/Generic/CustomerOrderVersionEstPostageSummaryList

No documentation available.
POST v1/Generic/CustomerContactInsert

Allows the user to insert one or many customer contacts from PRC.
POST v1/Generic/CustomerContactUpdate

Allows the user to update one or many customer contacts from PRC.
POST v1/Generic/InvoiceList

Return all of New Invoices
POST v1/Generic/EnableInvoicing

Set Invoice Status to Active or InActive.
POST v1/Generic/GetNewInvoiceNo

Return System New Customer Payment Number
POST v1/Generic/GetTitle?orderId={orderId}

Return Project Name from Order
POST v1/Generic/GetPaymentTerms

Return System Terms List
POST v1/Generic/InsertPaymentTerms

Creates new payment request.
POST v1/Generic/ProgramFee

Returns Program fee from Global Setting
POST v2/Generic/PaymentHistoryList

Get payment history list based on customerId or all customers
POST v1/Generic/PaymentHistoryList

Get payment history list based on customerId or all customers
POST v1/Generic/GetTaxJurisdiction

Return Tax Jurisdiction List
POST v1/Generic/CustomerAccountingUpdate

Updates customer record AccountingId and SyncToken
POST v1/Generic/TaxJurisdictionUpdate

Updates Tax Jurisdiction record External AccountingID
POST v1/Generic/PaymentTermsUpdate

Updates TermCode record External AccountingId
POST v1/Generic/GetCustomerDepositAccountList

Return all of Customer's Deposit Accounts
POST v1/Generic/CheckInvoice

Checks if Invoicing is off or on. Also gives equivalent order number or invoice number
DELETE v1/Generic/InvoiceDelete

Soft deletes an Invoice (Active to 0)
POST v1/Generic/InvoiceCheck

Checks draft Invoice for any new changes from previously saved Invoice Record
POST v1/Generic/Refund

Updates order / invoice record for refunds or voids coming from PRC
GET v1/Generic/CognitoSettings?domain={domain}

Returns Cognito Settings for a given domain
GET v1/Generic/tax-engine

Retrieves the Tax Calculation Engine details for the current domain using the MIS key from the bearer token. Returns the configured tax engine, or a default engine if none is found.

JobCost

APIDescription
POST v1/JobCost/JobCostServiceTimeEntry

Allows performing a 'Job Cost Service Time Entry'.
POST v1/JobCost/OperationList

Get Operation List
GET v1/JobCost/OrderOtherJobCostList?OrderNumber={OrderNumber}

Get Operation List
POST v1/JobCost/GetTimeCardData

Get TimeCard Data

Attachment

APIDescription
GET v1/Attachment/GetAttachment?FileId={FileId}&ModuleName={ModuleName}

Get Attachment Details.
GET v1/Attachment/DownloadAttachmentFile?FileId={FileId}&ModuleName={ModuleName}&MISKEY={MISKEY}

Download Attachment File.
GET v1/Attachment/DownloadTempAttachmentFile?FileGUID={FileGUID}&MISKEY={MISKEY}

Download Attachment from Temp Directory.

OneSourceTax

APIDescription
POST v1/OneSourceTax/OneSourceCalculateTax

Call Thomson Reuters OneSource REST API for calculating and committing tax and applying to Midnight estimates/orders
POST v1/OneSourceTax/OneSourceCalculateCommitReSubmit

Call Thomson Reuters OneSource REST API for calculating and committing tax ReSubmission and applying to Midnight estimates/orders

Licensee

APIDescription
POST v1/Licensee/CompanyList

Get Companies List
POST v1/Licensee/CountryList

Get Countries List

SystemSettings

APIDescription
POST v1/SystemSettings/MailClassList

Return System Mail Class List
POST v1/SystemSettings/MailSortList

Return System Mail Sort List
POST v1/SystemSettings/MailGeographyList

Return System Mail Geography List
POST v1/SystemSettings/PostOfficeList

Return System Post Office List
POST v1/SystemSettings/TermsList

Return System Terms List
POST v1/SystemSettings/DeliveryMethodList

Return Delivery Method List
POST v1/SystemSettings/JobTypeList

Return JobType List
POST v1/SystemSettings/ContactTypeList

Return ContactType List

Token

APIDescription
POST v1/Token/UserAuthentication

Generates API authorization token for domain and user.
POST v1/Token/UserLogout

Removes an existing API authorization token.
POST v1/Token/RegenerateAuthToken

Generates a replacement API authorization token for an existing token using its refresh token. Incase of Cognito login, it will not generate a new token.
POST v1/Token/OAuth2/AuthorizationCode

Validate OAUTH authorization code and return an Authorization token for a user.
GET v1/Token/oauth2-proxy?code={code}&state={state}&error={error}&error_description={error_description}

Proxy redirect an oauth IdP callback to the correct product
POST v1/Token/Amplify/Authenticate

Authenticates an Amplify user via Cognito token and returns a Midnight access/refresh token

ShipStationReadyToShip

APIDescription
GET v1/ShipStationReadyToShip

Returns one or more orders for ShipStation that are Ready to Ship
POST v1/ShipStationReadyToShip

Processes shipping updates from ShipStation that are Ready to Ship

Vendor

APIDescription
POST v1/Vendor/VendorContactInsert

Allows users to insert one or many vendor contacts.
POST v1/Vendor/VendorContactUpdate

Allows users to update one or many vendor contacts.
POST v1/Vendor/VendorInsert

Add vendor/s
POST v1/Vendor/VendorUpdate

Update vendor/s