SOAP to REST Conversion

Convert from Aspire’s External SOAP API to Aspire’s External REST API.

Authentication differences

The SOAP API uses a static username and password configured by Aspire CARE to retrieve a token per Entity Service.

The REST API uses a Bearer token that has expiration dates. You can retrieve these tokens from /Authorization with a user-generated ClientID and Secret. For more information, see Authentication & Authorization.

Specific Object Equivalents in Aspire Production

Select the following image to enlarge it, and reference the table below for the links to an object's SOAP and REST equivalent endpoints.

Links to specific object's SOAP and REST equivalent endpoints in Aspire Production:

Object	SOAP	REST Equivalent EndPoint
Companies	Companies Service	Companies
Contacts	Contacts Service	Contacts Pay Schedules Pay Rates
Deposits	Deposits Service	Bank Deposits
Invoices	ARInvoices	Invoices Invoice Batches Branches Properties Payment Terms
Item Allocation	InventoryTransactions Service	Item Allocations Receipts Work Tickets Opportunity Services Services Service Types Divisions Catalog Items Catalog Item Categories Unit Types
Opportunities	Opportunities Service	Opportunities
Payments	Payments Service	Payments Branches Contacts Divisions
Properties	Properties Service	Properties Property Contacts Property Statuses Localities
Purchase Receipts	Purchases Service	Receipts Vendors Receipt Statuses Inventory Locations
Work Ticket Time	TimeEntries Service	Work Ticket Times Branches
Users	Users Service	Users
Vendors	Vendors Service	Vendors
Work Tickets	WorkTickets Service	Work Tickets Opportunity Services Opportunities Properties Property Groups Contacts Regions Work Ticket Visits Routes

Documentation Index

SOAP to REST Conversion

Authentication differences

Specific Object Equivalents in Aspire Production