¶ Key Terminology
- Customers: Common Model treats Accounts as Customers
- Addresses: Common Model treats Contacts as Addresses
- Products: Common Model treats Products/Items as Products
¶ Known Integrations
PENDING
¶ Authentication
PENDING
¶ CRUD Operations
PENDING
¶
¶ Connect Specifics
¶ Known Types in Connect
| Type | Read | List | Create | Update | Delete |
|---|---|---|---|---|---|
| Customers | Get<Customers> | GetMany<Customers> | Upsert<Customers> | Upsert<Customers> | Delete<Customers> |
¶ Known Customizations
PENDING
¶ Outlying Issues
PENDING
¶ Common Model Mappings
¶ Common Model Workflows
¶ System to Common Model (Customer)
title System to Common Model [CUSTOMER]
participant System
participant C4
participant Common Model
C4->System: Request
loop For each Customer in List
note left of C4
Requirements:
Customer
Login Information
Address Information
end note
C4->System: Requests to fulfill all requirements
C4->Common Model: Map System data to Common Model Customer
C4->Common Model: Map System data to Common Model Login Information
C4->Common Model: Map System data to Common Model Address Information
¶ Common Model to System (Customer)
title Common Model to System [CUSTOMER]
participant Common Model
participant C4
participant System
C4->Common Model: Request Customer
C4->Common Model: Request Login Information
C4->Common Model: Request Address Information
C4->C4: Map System data to Common Model Customer
C4->C4: Map System data to Common Model Login Information
C4->C4: Map System data to Common Model Address Information
note right of C4
Some systems will allow for a single object to be posted to the endpoint
While others require each entity to be sent separately and possibly
in a specific order.
end note
C4->System: Request(s) to create/update to the System
¶ System to Common Model (Product)
title System to Common Model [PRODUCT]
participant System
participant C4
participant Common Model
C4->System: Request
loop For each Customer in List
note left of C4
Requirements:
Product Data
Price Data
Inventory Data
end note
C4->System: Requests to fulfill all requirements
C4->Common Model: Map System data to Common Model Product Data
C4->Common Model: Map System data to Common Model Pricing Data
C4->Common Model: Map System data to Common Model Inventory Data
¶ Common Model to System (Product)
title Common Model to System [PRODUCT]
participant Common Model
participant C4
participant System
C4->Common Model: Request Product Data
C4->Common Model: Request Pricing Data
C4->Common Model: Request Inventory Data
C4->C4: Map System data to Common Model Product Data
C4->C4: Map System data to Common Model Pricing Data
C4->C4: Map System data to Common Model Inventory Data
note right of C4
Some systems will allow for a single object to be posted to the endpoint
While others require each entity to be sent separately and possibly
in a specific order.
end note
C4->System: Request(s) to create/update to the System
¶ System to Common Model (Sales Order)
title System to Common Model [SALES ORDER]
participant System
participant C4
participant Common Model
C4->System: Request List of Sales Orders
loop For each Order in List
note left of C4
Requirements:
Sales Order Header information
Sales Order Billing information
Sales Order Shipping information
Sales Order Line Item information
end note
C4->System: Requests to fulfill all requirements
C4->Common Model: Map System data to Common Model Order Header
C4->Common Model: Map System data to Common Model Order Billing Contact
C4->Common Model: Map System data to Common Model Order Shipping Contact
C4->Common Model: Map System data to Common Model Order LineItem
¶ Common Model to System (Sales Order)
title Common Model to System [SALES ORDER]
participant Common Model
participant C4
participant System
C4->Common Model: Request Order Header
C4->Common Model: Request Order Billing Contact
C4->Common Model: Request Order Shipping Contact
C4->Common Model: Request Order Line Items
C4->C4: Map System data to Common Model Order Header
C4->C4: Map System data to Common Model Order Billing Contact
C4->C4: Map System data to Common Model Order Shipping Contact
C4->C4: Map System data to Common Model Order LineItem
note right of C4
Some systems will allow for a single object to be posted to the endpoint
While others require each entity to be sent separately and possibly
in a specific order.
end note
C4->System: Request(s) to create/update to the System
¶ System to Common Model (Sales Invoice)
title System to Common Model [SALES INVOICE]
participant System
participant C4
participant Common Model
C4->System: Request List of Sales Invoices
loop For each Invoice in List
note left of C4
Requirements:
Sales Invoice Header information
Sales Invoice Billing information
Sales Invoice Shipping information
Sales Invoice Line Item information
end note
C4->System: Requests to fulfill all requirements
C4->Common Model: Map System data to Common Model Invoice Header
C4->Common Model: Map System data to Common Model Invoice Billing Contact
C4->Common Model: Map System data to Common Model Invoice Shipping Contact
C4->Common Model: Map System data to Common Model Invoice LineItem
¶ Common Model to System (Sales Invoice)
title Common Model to System [SALES INVOICE]
participant Common Model
participant C4
participant System
C4->Common Model: Request Invoice Header
C4->Common Model: Request Invoice Billing Contact
C4->Common Model: Request Invoice Shipping Contact
C4->Common Model: Request Invoice Line Items
C4->C4: Map System data to Common Model Invoice Header
C4->C4: Map System data to Common Model Invoice Billing Contact
C4->C4: Map System data to Common Model Invoice Shipping Contact
C4->C4: Map System data to Common Model Invoice LineItem
note right of C4
Some systems will allow for a single object to be posted to the endpoint
While others require each entity to be sent separately and possibly
in a specific order.
end note
C4->System: Request(s) to create/update to the System
¶ System to Common Model (Sales Quote)
title System to Common Model [SALES QUOTE]
participant System
participant C4
participant Common Model
C4->System: Request List of Sales Quotes
loop For each Quote in List
note left of C4
Requirements:
Sales Quote Header information
Sales Quote Billing information
Sales Quote Shipping information
Sales Quote Line Item information
end note
C4->System: Requests to fulfill all requirements
C4->Common Model: Map System data to Common Model Quote Header
C4->Common Model: Map System data to Common Model Quote Billing Contact
C4->Common Model: Map System data to Common Model Quote Shipping Contact
C4->Common Model: Map System data to Common Model Quote LineItem
¶ Common Model to System (Sales Quote)
title Common Model to System [SALES QUOTE]
participant Common Model
participant C4
participant System
C4->Common Model: Request Quote Header
C4->Common Model: Request Quote Billing Contact
C4->Common Model: Request Quote Shipping Contact
C4->Common Model: Request Quote Line Items
C4->C4: Map System data to Common Model Quote Header
C4->C4: Map System data to Common Model Quote Billing Contact
C4->C4: Map System data to Common Model Quote Shipping Contact
C4->C4: Map System data to Common Model Quote LineItem
note right of C4
Some systems will allow for a single object to be posted to the endpoint
While others require each entity to be sent separately and possibly
in a specific order.
end note
C4->System: Request(s) to create/update to the System
