API docs by Redocly

Splash Php Client Module 3.0.0 (3.0.0)

Download OpenAPI specification:

Splash Open-Source & Universal Synchronisation WebService.

Address

  • Type: AddressMapper
  • Icon: fa fa-envelope-o

Sample Address Object to Expose Splash Scopes

Configuration

Action Allowed Push Pull
Create ✅ ✅ ✅
Update ✅ ✅ ✅
Delete ✅ ✅ ✅
alias
required
string <varchar> (Alias)

Address Alias

  • Template: Splash\Templates\Address\Core\Alias::class
  • Microdata: http://schema.org/PostalAddress → name
  • 📋 In List
thirdPartyId
string <objectid::ThirdParty> (Parent ThirdParty)

ThirdParty linked to this Address

  • Template: Splash\Templates\Address\Core\ThirdParty::class
  • Microdata: http://schema.org/Organization → ID
dateCreated
string <datetime> (Date Created)

Object creation date

  • Template: Splash\Templates\Common\Audit\DateCreated::class
  • Microdata: http://schema.org/DataFeedItem → dateCreated
dateModified
string <datetime> (Date Modified)

Last modification date

  • Template: Splash\Templates\Common\Audit\DateModified::class
  • Microdata: http://schema.org/DataFeedItem → dateModified
objectId
string <varchar> (Splash ID)

Splash unique object identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\ObjectId::class
  • Microdata: http://splashync.com/schemas → ObjectId
syncDateCreated
string <datetime> (Splash Created Date)

Date of first Splash synchronization

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\DateCreated::class
  • Microdata: http://splashync.com/schemas → DateCreated
originNodeId
string <varchar> (Source Server ID)

Splash source server identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeId::class
  • Microdata: http://splashync.com/schemas → SourceNodeId
originNodeName
string <varchar> (Source Server Name)

Splash source server name

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeName::class
  • Microdata: http://splashync.com/schemas → SourceNodeName
presence
string <varchar> (Splash Presence)

Object presence indicator on remote server

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\Presence::class
  • Microdata: http://splashync.com/schemas → Presence
company
string <varchar> (Company)

Company Name, leave empty for individuals

  • Template: Splash\Templates\Address\Contact\Name::class
  • Microdata: https://schema.org/PostalAddress → legalName
firstname
string <varchar> (First Name)

Contact Firstname

  • Template: Splash\Templates\Address\Contact\Firstname::class
  • Microdata: https://schema.org/PostalAddress → givenName
lastname
string <varchar> (Last Name)

Contact Lastname / Family Name

  • Template: Splash\Templates\Address\Contact\Lastname::class
  • Microdata: https://schema.org/PostalAddress → familyName
email
string <email> (Email Address)

Contact Email Address

  • Template: Splash\Templates\Address\Contact\Email::class
  • Microdata: https://schema.org/PostalAddress → email
phone
string <phone> (Phone)

Contact Phone Number

  • Template: Splash\Templates\Address\Contact\Phone::class
  • Microdata: https://schema.org/PostalAddress → phone
streetAddress
string <varchar> ([ADD1] Street address)

The street address. For example, 1600 Amphitheatre Pkwy.

  • Template: Splash\Templates\Address\PostalAddress\StreetAddress::class
  • Microdata: http://schema.org/PostalAddress → streetAddress
postOfficeBoxNumber
string <varchar> ([ADD2] Post office box number)

The post office box number for PO box addresses. For example, DN7524.

  • Template: Splash\Templates\Address\PostalAddress\PostOfficeBoxNumber::class
  • Microdata: http://schema.org/PostalAddress → postOfficeBoxNumber
extendedAddress
string <varchar> ([ADD3] Address extension)

An address extension such as an apartment number, C/O or alternative name.

  • Template: Splash\Templates\Address\PostalAddress\ExtendedAddress::class
  • Microdata: http://schema.org/PostalAddress → extendedAddress
postalCode
string <varchar> (Postal Code)

The postal code. For example, 94043.

  • Template: Splash\Templates\Address\PostalAddress\PostalCode::class
  • Microdata: http://schema.org/PostalAddress → postalCode
  • Options:
    • maxLength => 15
addressLocality
string <varchar> (Locality)

The locality in which the street address is, and which is in the region. I.e, Mountain View.

  • Template: Splash\Templates\Address\PostalAddress\Locality::class
  • Microdata: http://schema.org/PostalAddress → addressLocality
addressRegion
string <state> (Region / State Code)

Code of region or state in which the locality is, and which is in the country.

  • Template: Splash\Templates\Address\PostalAddress\RegionCode::class
  • Microdata: http://schema.org/PostalAddress → addressRegion
addressCountry
string <country> (Country ISO code)

The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.

  • Template: Splash\Templates\Address\PostalAddress\CountryCode::class
  • Microdata: http://schema.org/PostalAddress → addressCountry
duns
string <varchar> (Company Number / DUNS)

Company Number / DUNS Identifier

  • Template: Splash\Templates\Address\Identifiers\Duns::class
  • Microdata: https://schema.org/PostalAddress → duns
taxId
string <varchar> (Tax ID)

Organization Tax Identification Number

  • Template: Splash\Templates\Address\Identifiers\TaxId::class
  • Microdata: https://schema.org/PostalAddress → taxID
vatId
string <varchar> (VAT Number)

Intra-community VAT Number

  • Template: Splash\Templates\Address\Identifiers\VatId::class
  • Microdata: https://schema.org/PostalAddress → vatID
thirdParty__username
string <varchar> (User name)

ThirdParty or Company Name

  • Template: Splash\Templates\ThirdParty\Core\Name::class
  • Microdata: http://schema.org/Organization → legalName
  • 📜 Logged
thirdParty__lastname
string <varchar> (Last Name)

Person Lastname / Familly Name

  • Template: Splash\Templates\ThirdParty\Core\Lastname::class
  • Microdata: http://schema.org/Person → givenName
thirdParty__firstname
string <varchar> (First Name)

Person Firstname

  • Template: Splash\Templates\ThirdParty\Core\Firstname::class
  • Microdata: http://schema.org/Person → familyName
thirdParty__email
string <email> (Email Address)

ThirdParty Email Address

  • Template: Splash\Templates\ThirdParty\Core\Email::class
  • Microdata: http://schema.org/ContactPoint → email
thirdParty__phone
string <phone> (Phone)

Person Phone

  • Template: Splash\Templates\ThirdParty\Core\Phone::class
  • Microdata: http://schema.org/PostalAddress → telephone
addressCountryName
string <varchar> (Country name)

The country name.

  • Template: Splash\Templates\Address\PostalAddress\CountryName::class
  • Microdata: http://schema.org/PostalAddress → addressCountryName
{
  • "alias": "string",
  • "thirdPartyId": "728::ThirdParty",
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "company": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "email": "user@example.com",
  • "phone": "+33612345678",
  • "streetAddress": "string",
  • "postOfficeBoxNumber": "string",
  • "extendedAddress": "string",
  • "postalCode": "string",
  • "addressLocality": "string",
  • "addressRegion": "string",
  • "addressCountry": "string",
  • "duns": "string",
  • "taxId": "string",
  • "vatId": "string",
  • "thirdParty__username": "string",
  • "thirdParty__lastname": "string",
  • "thirdParty__firstname": "string",
  • "thirdParty__email": "user@example.com",
  • "thirdParty__phone": "+33612345678",
  • "addressCountryName": "string"
}

List Address

Read objects list — rows only carry fields flagged In List.

The server appends a meta entry to the result: { total, current } counters.

Request Body schema: application/json
required
filters
string or null

Text filter applied on searchable fields

object

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Read Address

Read object data — only requested fields are returned.

Request Body schema: application/json
required
id
required
string

Object identifier

fields
Array of strings

Ids of the fields to read

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "alias": "string",
  • "thirdPartyId": "728::ThirdParty",
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "company": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "email": "user@example.com",
  • "phone": "+33612345678",
  • "streetAddress": "string",
  • "postOfficeBoxNumber": "string",
  • "extendedAddress": "string",
  • "postalCode": "string",
  • "addressLocality": "string",
  • "addressRegion": "string",
  • "addressCountry": "string",
  • "duns": "string",
  • "taxId": "string",
  • "vatId": "string",
  • "thirdParty__username": "string",
  • "thirdParty__lastname": "string",
  • "thirdParty__firstname": "string",
  • "thirdParty__email": "user@example.com",
  • "thirdParty__phone": "+33612345678",
  • "addressCountryName": "string"
}

Write Address

Create or update object data — read-only fields are not writable and hidden from this request.

Request Body schema: application/json
required
id
string or null

Object identifier — null to create a new object

required
object (Address)

Sample Address Object to Expose Splash Scopes

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": {
    }
}

Response samples

Content type
application/json
"string"

Delete Address

Delete an object.

Request Body schema: application/json
required
id
required
string

Object identifier

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
true

Order

  • Type: OrderMapper
  • Icon: fa fa-shopping-cart

Sample Order Object including all Generic Fields Definitions: generic fields, order items, statuses & accounting relations.

Addresses Modes

Sale documents expose the customer link plus two denormalized address blocks, usually snapshots of the contacts taken at sale time:

Block Fields Microdata Usage
Customer thirdParty__* base ThirdParty microdata Customer snapshot
Billing billingAddress__* schema.org/billingAddress Billing contact at sale time
Shipping shippingAddress__* schema.org/deliveryAddress Delivery contact at sale time

Unlike the Customer — where the generic address holds the billing / administrative details — on sale documents (orders, invoices) the default address is the delivery one: logistics comes first.

  • Preferred: work with the thirdPartyId, billingAddressId & shippingAddressId object links (objectid), and sync Customer / Address objects separately.
  • Address blocks are best treated as read-only snapshots: use them to enrich the remote document display, not as a write channel.

Configuration

Action Allowed Push Pull
Create ✅ ✅ ✅
Update ✅ ✅ ✅
Delete ✅ ✅ ✅
dateCreated
string <datetime> (Date Created)

Object creation date

  • Template: Splash\Templates\Common\Audit\DateCreated::class
  • Microdata: http://schema.org/DataFeedItem → dateCreated
dateModified
string <datetime> (Date Modified)

Last modification date

  • Template: Splash\Templates\Common\Audit\DateModified::class
  • Microdata: http://schema.org/DataFeedItem → dateModified
objectId
string <varchar> (Splash ID)

Splash unique object identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\ObjectId::class
  • Microdata: http://splashync.com/schemas → ObjectId
syncDateCreated
string <datetime> (Splash Created Date)

Date of first Splash synchronization

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\DateCreated::class
  • Microdata: http://splashync.com/schemas → DateCreated
originNodeId
string <varchar> (Source Server ID)

Splash source server identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeId::class
  • Microdata: http://splashync.com/schemas → SourceNodeId
originNodeName
string <varchar> (Source Server Name)

Splash source server name

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeName::class
  • Microdata: http://splashync.com/schemas → SourceNodeName
presence
string <varchar> (Splash Presence)

Object presence indicator on remote server

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\Presence::class
  • Microdata: http://splashync.com/schemas → Presence
thirdPartyId
string <objectid::ThirdParty> (Customer)

Customer of the document (order / invoice)

  • Template: Splash\Templates\Accounting\Core\ThirdParty::class
  • Microdata: http://schema.org/Order → customer
billingAddressId
string <objectid::Address> (Billing Address)

Billing address of the document

  • Template: Splash\Templates\Accounting\Core\BillingAddress::class
  • Microdata: http://schema.org/Order → billingAddress
shippingAddressId
string <objectid::Address> (Shipping Address)

Shipping address of the document

  • Template: Splash\Templates\Accounting\Core\ShippingAddress::class
  • Microdata: http://schema.org/Order → orderDelivery
date
required
string <date> (Order Date)

Date the order was placed

  • Template: Splash\Templates\Order\Core\Date::class
  • Microdata: http://schema.org/Order → orderDate
  • 📋 In List
refInternal
string <varchar> (Internal Ref.)

Unique internal order reference

  • Template: Splash\Templates\Order\Core\RefInternal::class
  • Microdata: http://schema.org/Order → name
  • 🔎 Indexed 📋 In List
refCustomer
required
string <varchar> (Customer Ref.)

Customer-side order reference

  • Template: Splash\Templates\Order\Core\RefCustomer::class
  • Microdata: http://schema.org/Order → orderNumber
  • 🔎 Indexed 📋 In List
refExternal
string <varchar> (External Ref.)

External order reference

  • Template: Splash\Templates\Order\Core\RefExternal::class
  • Microdata: http://schema.org/Order → alternateName
  • 🔎 Indexed
thirdParty__lastname
string <varchar> (Last Name)

Person Lastname / Familly Name

  • Template: Splash\Templates\ThirdParty\Core\Lastname::class
  • Microdata: http://schema.org/Person → givenName
thirdParty__firstname
string <varchar> (First Name)

Person Firstname

  • Template: Splash\Templates\ThirdParty\Core\Firstname::class
  • Microdata: http://schema.org/Person → familyName
thirdParty__email
string <email> (Email Address)

ThirdParty Email Address

  • Template: Splash\Templates\ThirdParty\Core\Email::class
  • Microdata: http://schema.org/ContactPoint → email
billingAddress__firstname
string <varchar> ([BA] First Name)

Billing :First Name

  • Template: Splash\Templates\Accounting\Billing\Firstname::class
  • Microdata: https://schema.org/billingAddress → familyName
billingAddress__lastname
string <varchar> ([BA] Last Name)

Billing :Last Name

  • Template: Splash\Templates\Accounting\Billing\Lastname::class
  • Microdata: https://schema.org/billingAddress → givenName
billingAddress__email
string <email> ([BA] Email Address)

Billing :Email Address

  • Template: Splash\Templates\Accounting\Billing\Email::class
  • Microdata: https://schema.org/billingAddress → email
billingAddress__phone
string <phone> ([BA] Phone)

Billing :Phone

  • Template: Splash\Templates\Accounting\Billing\Phone::class
  • Microdata: https://schema.org/billingAddress → telephone
billingAddress__streetAddress
string <varchar> ([BA] [ADD1] Street address)

Billing :[ADD1] Street address

  • Template: Splash\Templates\Accounting\Billing\StreetAddress::class
  • Microdata: https://schema.org/billingAddress → streetAddress
billingAddress__postOfficeBoxNumber
string <varchar> ([BA] [ADD2] Post office box number)

Billing :[ADD2] Post office box number

  • Template: Splash\Templates\Accounting\Billing\PostOfficeBoxNumber::class
  • Microdata: https://schema.org/billingAddress → postOfficeBoxNumber
billingAddress__extendedAddress
string <varchar> ([BA] [ADD3] Address extension)

Billing :[ADD3] Address extension

  • Template: Splash\Templates\Accounting\Billing\ExtendedAddress::class
  • Microdata: https://schema.org/billingAddress → extendedAddress
billingAddress__postalCode
string <varchar> ([BA] Postal Code)

Billing :Postal Code

  • Template: Splash\Templates\Accounting\Billing\PostalCode::class
  • Microdata: https://schema.org/billingAddress → postalCode
  • Options:
    • maxLength => 15
billingAddress__addressLocality
string <varchar> ([BA] Locality)

Billing :Locality

  • Template: Splash\Templates\Accounting\Billing\Locality::class
  • Microdata: https://schema.org/billingAddress → addressLocality
billingAddress__addressRegion
string <state> ([BA] Region / State Code)

Billing :Region / State Code

  • Template: Splash\Templates\Accounting\Billing\RegionCode::class
  • Microdata: https://schema.org/billingAddress → addressRegion
billingAddress__addressCountry
string <country> ([BA] Country ISO code)

Billing :Country ISO code

  • Template: Splash\Templates\Accounting\Billing\CountryCode::class
  • Microdata: https://schema.org/billingAddress → addressCountry
billingAddress__duns
string <varchar> ([BA] Company Number / DUNS)

Billing :Company Number / DUNS

  • Template: Splash\Templates\Accounting\Billing\Duns::class
  • Microdata: https://schema.org/billingAddress → duns
billingAddress__taxId
string <varchar> ([BA] Tax ID)

Billing :Tax ID

  • Template: Splash\Templates\Accounting\Billing\TaxId::class
  • Microdata: https://schema.org/billingAddress → taxID
billingAddress__vatId
string <varchar> ([BA] VAT Number)

Billing :VAT Number

  • Template: Splash\Templates\Accounting\Billing\VatId::class
  • Microdata: https://schema.org/billingAddress → vatID
shippingAddress__firstname
string <varchar> (First Name)

Contact Firstname

  • Template: Splash\Templates\Address\Contact\Firstname::class
  • Microdata: https://schema.org/PostalAddress → givenName
shippingAddress__lastname
string <varchar> (Last Name)

Contact Lastname / Family Name

  • Template: Splash\Templates\Address\Contact\Lastname::class
  • Microdata: https://schema.org/PostalAddress → familyName
shippingAddress__email
string <email> (Email Address)

Contact Email Address

  • Template: Splash\Templates\Address\Contact\Email::class
  • Microdata: https://schema.org/PostalAddress → email
shippingAddress__phone
string <phone> (Phone)

Contact Phone Number

  • Template: Splash\Templates\Address\Contact\Phone::class
  • Microdata: https://schema.org/PostalAddress → phone
shippingAddress__streetAddress
string <varchar> ([ADD1] Street address)

The street address. For example, 1600 Amphitheatre Pkwy.

  • Template: Splash\Templates\Address\PostalAddress\StreetAddress::class
  • Microdata: http://schema.org/PostalAddress → streetAddress
shippingAddress__postOfficeBoxNumber
string <varchar> ([ADD2] Post office box number)

The post office box number for PO box addresses. For example, DN7524.

  • Template: Splash\Templates\Address\PostalAddress\PostOfficeBoxNumber::class
  • Microdata: http://schema.org/PostalAddress → postOfficeBoxNumber
shippingAddress__extendedAddress
string <varchar> ([ADD3] Address extension)

An address extension such as an apartment number, C/O or alternative name.

  • Template: Splash\Templates\Address\PostalAddress\ExtendedAddress::class
  • Microdata: http://schema.org/PostalAddress → extendedAddress
shippingAddress__postalCode
string <varchar> (Postal Code)

The postal code. For example, 94043.

  • Template: Splash\Templates\Address\PostalAddress\PostalCode::class
  • Microdata: http://schema.org/PostalAddress → postalCode
  • Options:
    • maxLength => 15
shippingAddress__addressLocality
string <varchar> (Locality)

The locality in which the street address is, and which is in the region. I.e, Mountain View.

  • Template: Splash\Templates\Address\PostalAddress\Locality::class
  • Microdata: http://schema.org/PostalAddress → addressLocality
shippingAddress__addressRegion
string <state> (Region / State Code)

Code of region or state in which the locality is, and which is in the country.

  • Template: Splash\Templates\Address\PostalAddress\RegionCode::class
  • Microdata: http://schema.org/PostalAddress → addressRegion
shippingAddress__addressCountry
string <country> (Country ISO code)

The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.

  • Template: Splash\Templates\Address\PostalAddress\CountryCode::class
  • Microdata: http://schema.org/PostalAddress → addressCountry
shippingAddress__duns
string <varchar> (Company Number / DUNS)

Company Number / DUNS Identifier

  • Template: Splash\Templates\Address\Identifiers\Duns::class
  • Microdata: https://schema.org/PostalAddress → duns
shippingAddress__taxId
string <varchar> (Tax ID)

Organization Tax Identification Number

  • Template: Splash\Templates\Address\Identifiers\TaxId::class
  • Microdata: https://schema.org/PostalAddress → taxID
shippingAddress__vatId
string <varchar> (VAT Number)

Intra-community VAT Number

  • Template: Splash\Templates\Address\Identifiers\VatId::class
  • Microdata: https://schema.org/PostalAddress → vatID
Array of objects (Items)
{
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "thirdPartyId": "439::ThirdParty",
  • "billingAddressId": "946::Address",
  • "shippingAddressId": "707::Address",
  • "date": "2026-07-24",
  • "refInternal": "string",
  • "refCustomer": "string",
  • "refExternal": "string",
  • "thirdParty__lastname": "string",
  • "thirdParty__firstname": "string",
  • "thirdParty__email": "user@example.com",
  • "billingAddress__firstname": "string",
  • "billingAddress__lastname": "string",
  • "billingAddress__email": "user@example.com",
  • "billingAddress__phone": "+33612345678",
  • "billingAddress__streetAddress": "string",
  • "billingAddress__postOfficeBoxNumber": "string",
  • "billingAddress__extendedAddress": "string",
  • "billingAddress__postalCode": "string",
  • "billingAddress__addressLocality": "string",
  • "billingAddress__addressRegion": "string",
  • "billingAddress__addressCountry": "string",
  • "billingAddress__duns": "string",
  • "billingAddress__taxId": "string",
  • "billingAddress__vatId": "string",
  • "shippingAddress__firstname": "string",
  • "shippingAddress__lastname": "string",
  • "shippingAddress__email": "user@example.com",
  • "shippingAddress__phone": "+33612345678",
  • "shippingAddress__streetAddress": "string",
  • "shippingAddress__postOfficeBoxNumber": "string",
  • "shippingAddress__extendedAddress": "string",
  • "shippingAddress__postalCode": "string",
  • "shippingAddress__addressLocality": "string",
  • "shippingAddress__addressRegion": "string",
  • "shippingAddress__addressCountry": "string",
  • "shippingAddress__duns": "string",
  • "shippingAddress__taxId": "string",
  • "shippingAddress__vatId": "string",
  • "items": [
    ]
}

List Order

Read objects list — rows only carry fields flagged In List.

The server appends a meta entry to the result: { total, current } counters.

Request Body schema: application/json
required
filters
string or null

Text filter applied on searchable fields

object

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Read Order

Read object data — only requested fields are returned.

Request Body schema: application/json
required
id
required
string

Object identifier

fields
Array of strings

Ids of the fields to read

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "thirdPartyId": "439::ThirdParty",
  • "billingAddressId": "946::Address",
  • "shippingAddressId": "707::Address",
  • "date": "2026-07-24",
  • "refInternal": "string",
  • "refCustomer": "string",
  • "refExternal": "string",
  • "thirdParty__lastname": "string",
  • "thirdParty__firstname": "string",
  • "thirdParty__email": "user@example.com",
  • "billingAddress__firstname": "string",
  • "billingAddress__lastname": "string",
  • "billingAddress__email": "user@example.com",
  • "billingAddress__phone": "+33612345678",
  • "billingAddress__streetAddress": "string",
  • "billingAddress__postOfficeBoxNumber": "string",
  • "billingAddress__extendedAddress": "string",
  • "billingAddress__postalCode": "string",
  • "billingAddress__addressLocality": "string",
  • "billingAddress__addressRegion": "string",
  • "billingAddress__addressCountry": "string",
  • "billingAddress__duns": "string",
  • "billingAddress__taxId": "string",
  • "billingAddress__vatId": "string",
  • "shippingAddress__firstname": "string",
  • "shippingAddress__lastname": "string",
  • "shippingAddress__email": "user@example.com",
  • "shippingAddress__phone": "+33612345678",
  • "shippingAddress__streetAddress": "string",
  • "shippingAddress__postOfficeBoxNumber": "string",
  • "shippingAddress__extendedAddress": "string",
  • "shippingAddress__postalCode": "string",
  • "shippingAddress__addressLocality": "string",
  • "shippingAddress__addressRegion": "string",
  • "shippingAddress__addressCountry": "string",
  • "shippingAddress__duns": "string",
  • "shippingAddress__taxId": "string",
  • "shippingAddress__vatId": "string",
  • "items": [
    ]
}

Write Order

Create or update object data — read-only fields are not writable and hidden from this request.

Request Body schema: application/json
required
id
string or null

Object identifier — null to create a new object

required
object (Order)

Sample Order Object including all Generic Fields Definitions: generic fields, order items, statuses & accounting relations.

Addresses Modes

Sale documents expose the customer link plus two denormalized address blocks, usually snapshots of the contacts taken at sale time:

Block Fields Microdata Usage
Customer thirdParty__* base ThirdParty microdata Customer snapshot
Billing billingAddress__* schema.org/billingAddress Billing contact at sale time
Shipping shippingAddress__* schema.org/deliveryAddress Delivery contact at sale time

Unlike the Customer — where the generic address holds the billing / administrative details — on sale documents (orders, invoices) the default address is the delivery one: logistics comes first.

  • Preferred: work with the thirdPartyId, billingAddressId & shippingAddressId object links (objectid), and sync Customer / Address objects separately.
  • Address blocks are best treated as read-only snapshots: use them to enrich the remote document display, not as a write channel.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": {
    }
}

Response samples

Content type
application/json
"string"

Delete Order

Delete an object.

Request Body schema: application/json
required
id
required
string

Object identifier

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
true

Product

  • Type: ProductMapper
  • Icon: fa fa-cubes

Splash\Core\Models\AbstractObject

Configuration

Action Allowed Push Pull
Create ✅ ✅ ✅
Update ✅ ✅ ✅
Delete ✅ ✅ ✅
dateCreated
string <datetime> (Date Created)

Object creation date

  • Template: Splash\Templates\Common\Audit\DateCreated::class
  • Microdata: http://schema.org/DataFeedItem → dateCreated
dateModified
string <datetime> (Date Modified)

Last modification date

  • Template: Splash\Templates\Common\Audit\DateModified::class
  • Microdata: http://schema.org/DataFeedItem → dateModified
objectId
string <varchar> (Splash ID)

Splash unique object identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\ObjectId::class
  • Microdata: http://splashync.com/schemas → ObjectId
syncDateCreated
string <datetime> (Splash Created Date)

Date of first Splash synchronization

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\DateCreated::class
  • Microdata: http://splashync.com/schemas → DateCreated
originNodeId
string <varchar> (Source Server ID)

Splash source server identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeId::class
  • Microdata: http://splashync.com/schemas → SourceNodeId
originNodeName
string <varchar> (Source Server Name)

Splash source server name

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeName::class
  • Microdata: http://splashync.com/schemas → SourceNodeName
presence
string <varchar> (Splash Presence)

Object presence indicator on remote server

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\Presence::class
  • Microdata: http://splashync.com/schemas → Presence
sku
required
string <varchar> (Reference)

Product reference (SKU)

  • Template: Splash\Templates\Product\Core\ProductSku::class
  • Microdata: http://schema.org/Product → model
  • 🔎 Indexed 📋 In List 📜 Logged
name
required
string <varchar> (Product Name)

Full product name

  • Template: Splash\Templates\Product\Core\Name::class
  • Microdata: http://schema.org/Product → name
  • 📋 In List
alternateName
string <varchar> (Alternate Name)

Product alternate or short name

  • Template: Splash\Templates\Product\Core\AlternateName::class
  • Microdata: http://schema.org/Product → alternateName
weight
number <double> (Weight)

Product weight

  • Template: Splash\Templates\Product\Dimensions\Weight::class
  • Microdata: http://schema.org/Product → weight
length
number <double> (Length)

Product length

  • Template: Splash\Templates\Product\Dimensions\Length::class
  • Microdata: http://schema.org/Product → depth
width
number <double> (Width)

Product width

  • Template: Splash\Templates\Product\Dimensions\Width::class
  • Microdata: http://schema.org/Product → width
height
number <double> (Height)

Product height

  • Template: Splash\Templates\Product\Dimensions\Height::class
  • Microdata: http://schema.org/Product → height
surface
number <double> (Surface Area)

Product surface area

  • Template: Splash\Templates\Product\Dimensions\Surface::class
  • Microdata: http://schema.org/Product → surface
volume
number <double> (Volume)

Product volume

  • Template: Splash\Templates\Product\Dimensions\Volume::class
  • Microdata: http://schema.org/Product → volume
ean13
string <varchar> (EAN 13)

Product EAN barcode

  • Template: Splash\Templates\Product\Identifiers\Ean13::class
  • Microdata: http://schema.org/Product → gtin13
upc
string <varchar> (UPC)

Product UPC barcode

  • Template: Splash\Templates\Product\Identifiers\Upc::class
  • Microdata: http://schema.org/Product → gtin12
isbn
string <varchar> (ISBN)

Product ISBN code

  • Template: Splash\Templates\Product\Identifiers\Isbn::class
  • Microdata: http://schema.org/Product → gtin14
mpn
string <varchar> (MPN)

Manufacturer part number

  • Template: Splash\Templates\Product\Identifiers\Mpn::class
  • Microdata: http://schema.org/Product → mpn
barcode
string <varchar> (Barcode)

Product barcode

  • Template: Splash\Templates\Product\Identifiers\Barcode::class
  • Microdata: http://schema.org/Product → qrcode
offered
boolean <bool> (Available for Sale)

Product is available for sale

  • Template: Splash\Templates\Product\Flags\Offered::class
  • Microdata: http://schema.org/Product → offered
stockLevel
integer <int> (Stock Level)

Current stock quantity

  • Template: Splash\Templates\Product\Stock\StockLevel::class
  • Microdata: http://schema.org/Offer → inventoryLevel
  • 📋 In List
stockAlertLevel
integer <int> (Alert Level)

Stock alert threshold

  • Template: Splash\Templates\Product\Stock\StockAlertLevel::class
  • Microdata: http://schema.org/Offer → inventoryAlertLevel
stockTargetLevel
integer <int> (Target Level)

Desired stock level

  • Template: Splash\Templates\Product\Stock\StockTargetLevel::class
  • Microdata: http://schema.org/Offer → inventoryTargetLevel
isDefault
boolean <bool> (Is Default Variant)

Indicates if this variant is the default one

  • Template: Splash\Templates\Product\Variants\IsDefault::class
  • Microdata: http://schema.org/Product → isDefaultVariation
  • 🧪 No Tests
baseProduct__sku
string <varchar> (Parent SKU)

Parent product SKU of this variant

  • Template: Splash\Templates\Product\Variants\ParentSku::class
  • Microdata: http://schema.org/Product → isVariationOfName
baseProduct__dateCreated
string <datetime> (Date Created)

Object creation date

  • Template: Splash\Templates\Common\Audit\DateCreated::class
  • Microdata: http://schema.org/DataFeedItem → dateCreated
baseProduct__dateModified
string <datetime> (Date Modified)

Last modification date

  • Template: Splash\Templates\Common\Audit\DateModified::class
  • Microdata: http://schema.org/DataFeedItem → dateModified
baseProduct__shortDescription
string <varchar> (Short Description)

Product short description

  • Template: Splash\Templates\Product\Core\ShortDescription::class
  • Microdata: http://schema.org/Product → description
  • Options:
    • language => fr_FR
baseProduct__shortDescriptionUs
string <varchar> (Short Description)

Product short description

  • Template: Splash\Templates\Product\Core\ShortDescription::class
  • Microdata: http://schema.org/Product/en_US → description
  • Options:
    • language => en_US
baseProduct__longDescription
string <text> (Long Description)

Product long or detailed description

  • Template: Splash\Templates\Product\Core\LongDescription::class
  • Microdata: http://schema.org/Product → articleBody
  • Options:
    • language => fr_FR
  • 📜 Logged
baseProduct__longDescriptionUs
string <text> (Long Description)

Product long or detailed description

  • Template: Splash\Templates\Product\Core\LongDescription::class
  • Microdata: http://schema.org/Product/en_Us → articleBody
  • Options:
    • language => en_Us
  • 📜 Logged
baseProduct__warehouse
string <varchar> (Warehouse)

Default warehouse location

  • Template: Splash\Templates\Product\Stock\Warehouse::class
  • Microdata: http://schema.org/Offer → inventoryLocation
baseProduct__minQuantity
integer <int> (Minimum Quantity)

Minimum purchase quantity

  • Template: Splash\Templates\Product\Stock\MinQuantity::class
  • Microdata: http://schema.org/Offer → eligibleTransactionVolume
baseProduct__active
boolean <bool> (Active)

Product is active

  • Template: Splash\Templates\Product\Flags\Active::class
  • Microdata: http://schema.org/Product → active
baseProduct__onSale
boolean <bool> (On Sale)

Product is on sale

  • Template: Splash\Templates\Product\Flags\OnSale::class
  • Microdata: http://schema.org/Product → onsale
baseProduct__metaDescription
string <varchar> (Meta Description)

SEO meta description

  • Template: Splash\Templates\Product\Seo\MetaDescription::class
  • Microdata: http://schema.org/Article → headline
  • Options:
    • language => fr_FR
baseProduct__metaDescriptionUs
string <varchar> (Meta Description)

SEO meta description

  • Template: Splash\Templates\Product\Seo\MetaDescription::class
  • Microdata: http://schema.org/Article/en_Us → headline
  • Options:
    • language => en_Us
baseProduct__metaKeywords
string <varchar> (Meta Keywords)

SEO meta keywords

  • Template: Splash\Templates\Product\Seo\MetaKeywords::class
  • Microdata: http://schema.org/Article → keywords
  • Options:
    • language => fr_FR
baseProduct__metaKeywordsUs
string <varchar> (Meta Keywords)

SEO meta keywords

  • Template: Splash\Templates\Product\Seo\MetaKeywords::class
  • Microdata: http://schema.org/Article/en_Us → keywords
  • Options:
    • language => en_Us
baseProduct__urlRewrite
string <varchar> (Friendly URL)

SEO-friendly URL slug

  • Template: Splash\Templates\Product\Seo\UrlRewrite::class
  • Microdata: http://schema.org/Article → urlRewrite
  • Options:
    • language => fr_FR
baseProduct__urlRewriteUs
string <varchar> (Friendly URL)

SEO-friendly URL slug

  • Template: Splash\Templates\Product\Seo\UrlRewrite::class
  • Microdata: http://schema.org/Article/en_Us → urlRewrite
  • Options:
    • language => en_Us
object <price> (Base Price)

Product base price (excl. tax)

  • Template: Splash\Templates\Product\Pricing\BasePrice::class
  • Microdata: http://schema.org/Product → basePrice
nameWithOptions
string <varchar> (Name with Options)

Product name with variant options

  • Template: Splash\Templates\Product\Core\NameWithOptions::class
  • Microdata: http://schema.org/Product → variantName
  • 📜 Logged
object <price> (Price)

Product selling price

  • Template: Splash\Templates\Product\Pricing\Price::class
  • Microdata: http://schema.org/Product → price
  • 📋 In List
object <price> (Wholesale Price)

Product wholesale / cost price

  • Template: Splash\Templates\Product\Pricing\WholesalePrice::class
  • Microdata: http://schema.org/Product → wholesalePrice
stockAlertFlag
boolean <bool> (Stock Alert)

Stock is below alert level

  • Template: Splash\Templates\Product\Stock\StockAlertFlag::class
  • Microdata: http://schema.org/Offer → inventoryAlertFlag
defaultVariant
string <objectid::Product> (Default Variant)

Default variant product identifier

  • Template: Splash\Templates\Product\Variants\DefaultVariant::class
  • Microdata: http://schema.org/Product → DefaultVariation
parentProduct
string <varchar> (Parent Product)

Parent product identifier of this variant

  • Template: Splash\Templates\Product\Variants\ParentProduct::class
  • Microdata: http://schema.org/Product → isVariationOf
Array of objects (Attributes)
Array of objects (Variants)
{
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "sku": "string",
  • "name": "string",
  • "alternateName": "string",
  • "weight": 0.1,
  • "length": 0.1,
  • "width": 0.1,
  • "height": 0.1,
  • "surface": 0.1,
  • "volume": 0.1,
  • "ean13": "string",
  • "upc": "string",
  • "isbn": "string",
  • "mpn": "string",
  • "barcode": "string",
  • "offered": true,
  • "stockLevel": 0,
  • "stockAlertLevel": 0,
  • "stockTargetLevel": 0,
  • "isDefault": true,
  • "baseProduct__sku": "string",
  • "baseProduct__dateCreated": "2026-07-24 11:55:40",
  • "baseProduct__dateModified": "2026-07-24 11:55:40",
  • "baseProduct__shortDescription": "string",
  • "baseProduct__shortDescriptionUs": "string",
  • "baseProduct__longDescription": "string",
  • "baseProduct__longDescriptionUs": "string",
  • "baseProduct__warehouse": "string",
  • "baseProduct__minQuantity": 0,
  • "baseProduct__active": true,
  • "baseProduct__onSale": true,
  • "baseProduct__metaDescription": "string",
  • "baseProduct__metaDescriptionUs": "string",
  • "baseProduct__metaKeywords": "string",
  • "baseProduct__metaKeywordsUs": "string",
  • "baseProduct__urlRewrite": "string",
  • "baseProduct__urlRewriteUs": "string",
  • "baseProduct__basePrice": {
    },
  • "nameWithOptions": "string",
  • "price": {
    },
  • "wholesalePrice": {
    },
  • "stockAlertFlag": true,
  • "defaultVariant": "214::Product",
  • "parentProduct": "string",
  • "attributes": [
    ],
  • "variants": [
    ]
}

List Product

Read objects list — rows only carry fields flagged In List.

The server appends a meta entry to the result: { total, current } counters.

Request Body schema: application/json
required
filters
string or null

Text filter applied on searchable fields

object

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Read Product

Read object data — only requested fields are returned.

Request Body schema: application/json
required
id
required
string

Object identifier

fields
Array of strings

Ids of the fields to read

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "sku": "string",
  • "name": "string",
  • "alternateName": "string",
  • "weight": 0.1,
  • "length": 0.1,
  • "width": 0.1,
  • "height": 0.1,
  • "surface": 0.1,
  • "volume": 0.1,
  • "ean13": "string",
  • "upc": "string",
  • "isbn": "string",
  • "mpn": "string",
  • "barcode": "string",
  • "offered": true,
  • "stockLevel": 0,
  • "stockAlertLevel": 0,
  • "stockTargetLevel": 0,
  • "isDefault": true,
  • "baseProduct__sku": "string",
  • "baseProduct__dateCreated": "2026-07-24 11:55:40",
  • "baseProduct__dateModified": "2026-07-24 11:55:40",
  • "baseProduct__shortDescription": "string",
  • "baseProduct__shortDescriptionUs": "string",
  • "baseProduct__longDescription": "string",
  • "baseProduct__longDescriptionUs": "string",
  • "baseProduct__warehouse": "string",
  • "baseProduct__minQuantity": 0,
  • "baseProduct__active": true,
  • "baseProduct__onSale": true,
  • "baseProduct__metaDescription": "string",
  • "baseProduct__metaDescriptionUs": "string",
  • "baseProduct__metaKeywords": "string",
  • "baseProduct__metaKeywordsUs": "string",
  • "baseProduct__urlRewrite": "string",
  • "baseProduct__urlRewriteUs": "string",
  • "baseProduct__basePrice": {
    },
  • "nameWithOptions": "string",
  • "price": {
    },
  • "wholesalePrice": {
    },
  • "stockAlertFlag": true,
  • "defaultVariant": "214::Product",
  • "parentProduct": "string",
  • "attributes": [
    ],
  • "variants": [
    ]
}

Write Product

Create or update object data — read-only fields are not writable and hidden from this request.

Request Body schema: application/json
required
id
string or null

Object identifier — null to create a new object

required
object (Product)

Splash\Core\Models\AbstractObject

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": {
    }
}

Response samples

Content type
application/json
"string"

Delete Product

Delete an object.

Request Body schema: application/json
required
id
required
string

Object identifier

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
true

ThirdParty

  • Type: ThirdPartyMapper
  • Icon: fa fa-user

Sample Customer Object to Expose Splash Scopes: identity, identifiers, marketing flags & owned addresses.

Addresses Modes

Three address levels may coexist on a Customer:

Block Fields Microdata Usage
Generic unprefixed (streetAddress, ...) schema.org/PostalAddress Main — billing details by convention
Billing Contact billingAddress__* schema.org/billingAddress Optional dedicated billing contact
Shipping Contact shippingAddress__* schema.org/deliveryAddress Optional dedicated delivery contact

Contacts may also be exposed as standalone Address objects, linked from the Customer via billingAddressId / shippingAddressId (objectid::Address).

  • Preferred: sync the generic block on the Customer, and manage the optional contacts as standalone Address objects, using the objectid links.
  • One-shot: expose the billingAddress__* / shippingAddress__* blocks to sync the Customer and both contacts in a single call.

Avoid mixing both write channels (objectid link and __ block) for the same address in a single request.

Identifiers

Company identifiers follow schema.org semantics: duns (SIREN in France), vatId (EU VAT number), taxId (national tax ID), naics & isicV4 (activity classifications).

Primary Key

email is the recommended primary field for customers, but any unique field may fit, depending on the connector context (i.e. phone number).

Configuration

Action Allowed Push Pull
Create ✅ ✅ ✅
Update ✅ ✅ ✅
Delete ✅ ✅ ✅
username
required
string <varchar> (User name)

ThirdParty or Company Name

  • Template: Splash\Templates\ThirdParty\Core\Name::class
  • Microdata: http://schema.org/Organization → legalName
  • 🔎 Indexed 📋 In List 📜 Logged
lastname
string <varchar> (Last Name)

Person Lastname / Familly Name

  • Template: Splash\Templates\ThirdParty\Core\Lastname::class
  • Microdata: http://schema.org/Person → givenName
firstname
string <varchar> (First Name)

Person Firstname

  • Template: Splash\Templates\ThirdParty\Core\Firstname::class
  • Microdata: http://schema.org/Person → familyName
email
required
string <email> (Email Address)

ThirdParty Email Address

  • Template: Splash\Templates\ThirdParty\Core\Email::class
  • Microdata: http://schema.org/ContactPoint → email
  • 🔑 Primary 🔎 Indexed 📋 In List
phone
string <phone> (Phone)

Person Phone

  • Template: Splash\Templates\ThirdParty\Core\Phone::class
  • Microdata: http://schema.org/PostalAddress → telephone
mobilePhone
string <phone> (Mobile Phone)

Person Mobile Phone

  • Template: Splash\Templates\ThirdParty\Core\MobilePhone::class
  • Microdata: http://schema.org/Person → telephone
fax
string <phone> (Fax)

Fax Number

  • Template: Splash\Templates\ThirdParty\Core\Fax::class
  • Microdata: http://schema.org/Organization → faxNumber
gender
string <varchar> (Civility Type)
Enum: "m" "f" "n"

Normalized Civility Type

  • Template: Splash\Templates\ThirdParty\Profile\CivilityType::class
  • Microdata: http://schema.org/Person → gender
genderName
string <varchar> (Civility Name)

Civility Type Name

  • Template: Splash\Templates\ThirdParty\Profile\CivilityName::class
  • Microdata: http://schema.org/Person → honorificPrefix
url
string <url> (Website Url)

Website / Profile Url

  • Template: Splash\Templates\ThirdParty\Profile\Website::class
  • Microdata: http://schema.org/Organization → url
dateCreated
string <datetime> (Date Created)

Object creation date

  • Template: Splash\Templates\Common\Audit\DateCreated::class
  • Microdata: http://schema.org/DataFeedItem → dateCreated
dateModified
string <datetime> (Date Modified)

Last modification date

  • Template: Splash\Templates\Common\Audit\DateModified::class
  • Microdata: http://schema.org/DataFeedItem → dateModified
objectId
string <varchar> (Splash ID)

Splash unique object identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\ObjectId::class
  • Microdata: http://splashync.com/schemas → ObjectId
syncDateCreated
string <datetime> (Splash Created Date)

Date of first Splash synchronization

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\DateCreated::class
  • Microdata: http://splashync.com/schemas → DateCreated
originNodeId
string <varchar> (Source Server ID)

Splash source server identifier

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeId::class
  • Microdata: http://splashync.com/schemas → SourceNodeId
originNodeName
string <varchar> (Source Server Name)

Splash source server name

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\OriginNodeName::class
  • Microdata: http://splashync.com/schemas → SourceNodeName
presence
string <varchar> (Splash Presence)

Object presence indicator on remote server

  • Prefer Write — field should only be written & imported from other servers
  • Template: Splash\Templates\Common\Sync\Presence::class
  • Microdata: http://splashync.com/schemas → Presence
company
string <varchar> (Company)

Company Name, leave empty for individuals

  • Template: Splash\Templates\Address\Contact\Name::class
  • Microdata: https://schema.org/PostalAddress → legalName
streetAddress
string <varchar> ([ADD1] Street address)

The street address. For example, 1600 Amphitheatre Pkwy.

  • Template: Splash\Templates\Address\PostalAddress\StreetAddress::class
  • Microdata: http://schema.org/PostalAddress → streetAddress
postOfficeBoxNumber
string <varchar> ([ADD2] Post office box number)

The post office box number for PO box addresses. For example, DN7524.

  • Template: Splash\Templates\Address\PostalAddress\PostOfficeBoxNumber::class
  • Microdata: http://schema.org/PostalAddress → postOfficeBoxNumber
extendedAddress
string <varchar> ([ADD3] Address extension)

An address extension such as an apartment number, C/O or alternative name.

  • Template: Splash\Templates\Address\PostalAddress\ExtendedAddress::class
  • Microdata: http://schema.org/PostalAddress → extendedAddress
postalCode
string <varchar> (Postal Code)

The postal code. For example, 94043.

  • Template: Splash\Templates\Address\PostalAddress\PostalCode::class
  • Microdata: http://schema.org/PostalAddress → postalCode
  • Options:
    • maxLength => 15
addressLocality
string <varchar> (Locality)

The locality in which the street address is, and which is in the region. I.e, Mountain View.

  • Template: Splash\Templates\Address\PostalAddress\Locality::class
  • Microdata: http://schema.org/PostalAddress → addressLocality
addressRegion
string <state> (Region / State Code)

Code of region or state in which the locality is, and which is in the country.

  • Template: Splash\Templates\Address\PostalAddress\RegionCode::class
  • Microdata: http://schema.org/PostalAddress → addressRegion
addressCountry
string <country> (Country ISO code)

The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.

  • Template: Splash\Templates\Address\PostalAddress\CountryCode::class
  • Microdata: http://schema.org/PostalAddress → addressCountry
duns
string <varchar> (Company Number / DUNS)

Company Number / DUNS Identifier

  • Template: Splash\Templates\Address\Identifiers\Duns::class
  • Microdata: https://schema.org/PostalAddress → duns
taxId
string <varchar> (Tax ID)

Organization Tax Identification Number

  • Template: Splash\Templates\Address\Identifiers\TaxId::class
  • Microdata: https://schema.org/PostalAddress → taxID
vatId
string <varchar> (VAT Number)

Intra-community VAT Number

  • Template: Splash\Templates\Address\Identifiers\VatId::class
  • Microdata: https://schema.org/PostalAddress → vatID
billingAddressId
string <objectid::Address> (Billing Address)

Billing address of the document

  • Template: Splash\Templates\Accounting\Core\BillingAddress::class
  • Microdata: http://schema.org/Order → billingAddress
shippingAddressId
string <objectid::Address> (Shipping Address)

Shipping address of the document

  • Template: Splash\Templates\Accounting\Core\ShippingAddress::class
  • Microdata: http://schema.org/Order → orderDelivery
naics
string <varchar> (NAICS / APE Code)

Activity Classification Code (NAICS / APE)

  • Template: Splash\Templates\ThirdParty\Identifiers\Naics::class
  • Microdata: http://schema.org/Organization → naics
isicV4
string <varchar> (ISIC v4 Code)

ISIC v4 Activity Classification Code

  • Template: Splash\Templates\ThirdParty\Identifiers\IsicV4::class
  • Microdata: http://schema.org/Organization → isicV4
active
boolean <bool> (Active)

ThirdParty is active

  • Template: Splash\Templates\ThirdParty\Flags\Active::class
  • Microdata: http://schema.org/Organization → active
prospect
boolean <bool> (Prospect)

ThirdParty is a prospect

  • Template: Splash\Templates\ThirdParty\Flags\Prospect::class
  • Microdata: http://schema.org/Organization → prospect
customer
boolean <bool> (Customer)

ThirdParty is a customer

  • Template: Splash\Templates\ThirdParty\Flags\Customer::class
  • Microdata: http://schema.org/Organization → customer
supplier
boolean <bool> (Supplier)

ThirdParty is a supplier

  • Template: Splash\Templates\ThirdParty\Flags\Supplier::class
  • Microdata: http://schema.org/Organization → supplier
useVat
boolean <bool> (VAT Subject)

ThirdParty is subject to VAT

  • Template: Splash\Templates\ThirdParty\Flags\UseVat::class
  • Microdata: http://schema.org/Organization → UseVAT
newsletter
boolean <bool> (Newsletter)

Newsletter subscription

  • Template: Splash\Templates\ThirdParty\Marketing\Newsletter::class
  • Microdata: http://schema.org/Organization → newsletter
advertising
boolean <bool> (Advertising Opt-in)

Accepts advertising communications

  • Template: Splash\Templates\ThirdParty\Marketing\Advertising::class
  • Microdata: http://schema.org/Organization → advertising
noEmail
boolean <bool> (Email Opt-Out)

Email sending blocked for this contact

  • Template: Splash\Templates\ThirdParty\Marketing\NoEmail::class
  • Microdata: http://schema.org/ContactPoint → emailOptOut
noSms
boolean <bool> (SMS Opt-Out)

SMS sending blocked for this contact

  • Template: Splash\Templates\ThirdParty\Marketing\NoSms::class
  • Microdata: http://schema.org/ContactPoint → smsOptOut
mailingListName
string <inline> (Mailing List)

Name of the mailing list

  • Template: Splash\Templates\ThirdParty\Marketing\MailingListName::class
  • Microdata: http://schema.org/Organization → mailingListNames
billingAddress__company
string <varchar> ([BA] Company)

Billing :Company

  • Template: Splash\Templates\Accounting\Billing\Name::class
  • Microdata: https://schema.org/billingAddress → legalName
  • 📜 Logged
billingAddress__firstname
string <varchar> ([BA] First Name)

Billing :First Name

  • Template: Splash\Templates\Accounting\Billing\Firstname::class
  • Microdata: https://schema.org/billingAddress → familyName
billingAddress__lastname
string <varchar> ([BA] Last Name)

Billing :Last Name

  • Template: Splash\Templates\Accounting\Billing\Lastname::class
  • Microdata: https://schema.org/billingAddress → givenName
billingAddress__email
string <email> ([BA] Email Address)

Billing :Email Address

  • Template: Splash\Templates\Accounting\Billing\Email::class
  • Microdata: https://schema.org/billingAddress → email
billingAddress__phone
string <phone> ([BA] Phone)

Billing :Phone

  • Template: Splash\Templates\Accounting\Billing\Phone::class
  • Microdata: https://schema.org/billingAddress → telephone
billingAddress__streetAddress
string <varchar> ([BA] [ADD1] Street address)

Billing :[ADD1] Street address

  • Template: Splash\Templates\Accounting\Billing\StreetAddress::class
  • Microdata: https://schema.org/billingAddress → streetAddress
billingAddress__postOfficeBoxNumber
string <varchar> ([BA] [ADD2] Post office box number)

Billing :[ADD2] Post office box number

  • Template: Splash\Templates\Accounting\Billing\PostOfficeBoxNumber::class
  • Microdata: https://schema.org/billingAddress → postOfficeBoxNumber
billingAddress__extendedAddress
string <varchar> ([BA] [ADD3] Address extension)

Billing :[ADD3] Address extension

  • Template: Splash\Templates\Accounting\Billing\ExtendedAddress::class
  • Microdata: https://schema.org/billingAddress → extendedAddress
billingAddress__postalCode
string <varchar> ([BA] Postal Code)

Billing :Postal Code

  • Template: Splash\Templates\Accounting\Billing\PostalCode::class
  • Microdata: https://schema.org/billingAddress → postalCode
  • Options:
    • maxLength => 15
billingAddress__addressLocality
string <varchar> ([BA] Locality)

Billing :Locality

  • Template: Splash\Templates\Accounting\Billing\Locality::class
  • Microdata: https://schema.org/billingAddress → addressLocality
billingAddress__addressRegion
string <state> ([BA] Region / State Code)

Billing :Region / State Code

  • Template: Splash\Templates\Accounting\Billing\RegionCode::class
  • Microdata: https://schema.org/billingAddress → addressRegion
billingAddress__addressCountry
string <country> ([BA] Country ISO code)

Billing :Country ISO code

  • Template: Splash\Templates\Accounting\Billing\CountryCode::class
  • Microdata: https://schema.org/billingAddress → addressCountry
billingAddress__duns
string <varchar> ([BA] Company Number / DUNS)

Billing :Company Number / DUNS

  • Template: Splash\Templates\Accounting\Billing\Duns::class
  • Microdata: https://schema.org/billingAddress → duns
billingAddress__taxId
string <varchar> ([BA] Tax ID)

Billing :Tax ID

  • Template: Splash\Templates\Accounting\Billing\TaxId::class
  • Microdata: https://schema.org/billingAddress → taxID
billingAddress__vatId
string <varchar> ([BA] VAT Number)

Billing :VAT Number

  • Template: Splash\Templates\Accounting\Billing\VatId::class
  • Microdata: https://schema.org/billingAddress → vatID
shippingAddress__company
string <varchar> ([DA] Company)

Delivery : Company

  • Template: Splash\Templates\Accounting\Delivery\Name::class
  • Microdata: https://schema.org/deliveryAddress → legalName
  • 📜 Logged
shippingAddress__firstname
string <varchar> ([DA] First Name)

Delivery : First Name

  • Template: Splash\Templates\Accounting\Delivery\Firstname::class
  • Microdata: https://schema.org/deliveryAddress → familyName
shippingAddress__lastname
string <varchar> ([DA] Last Name)

Delivery : Last Name

  • Template: Splash\Templates\Accounting\Delivery\Lastname::class
  • Microdata: https://schema.org/deliveryAddress → givenName
shippingAddress__email
string <email> ([DA] Email Address)

Delivery : Email Address

  • Template: Splash\Templates\Accounting\Delivery\Email::class
  • Microdata: https://schema.org/deliveryAddress → email
shippingAddress__phone
string <phone> ([DA] Phone)

Delivery : Phone

  • Template: Splash\Templates\Accounting\Delivery\Phone::class
  • Microdata: https://schema.org/deliveryAddress → telephone
shippingAddress__streetAddress
string <varchar> ([DA] [ADD1] Street address)

Delivery : [ADD1] Street address

  • Template: Splash\Templates\Accounting\Delivery\StreetAddress::class
  • Microdata: https://schema.org/deliveryAddress → streetAddress
shippingAddress__postOfficeBoxNumber
string <varchar> ([DA] [ADD2] Post office box number)

Delivery : [ADD2] Post office box number

  • Template: Splash\Templates\Accounting\Delivery\PostOfficeBoxNumber::class
  • Microdata: https://schema.org/deliveryAddress → postOfficeBoxNumber
shippingAddress__extendedAddress
string <varchar> ([DA] [ADD3] Address extension)

Delivery : [ADD3] Address extension

  • Template: Splash\Templates\Accounting\Delivery\ExtendedAddress::class
  • Microdata: https://schema.org/deliveryAddress → extendedAddress
shippingAddress__postalCode
string <varchar> ([DA] Postal Code)

Delivery : Postal Code

  • Template: Splash\Templates\Accounting\Delivery\PostalCode::class
  • Microdata: https://schema.org/deliveryAddress → postalCode
  • Options:
    • maxLength => 15
shippingAddress__addressLocality
string <varchar> ([DA] Locality)

Delivery : Locality

  • Template: Splash\Templates\Accounting\Delivery\Locality::class
  • Microdata: https://schema.org/deliveryAddress → addressLocality
shippingAddress__addressRegion
string <state> ([DA] Region / State Code)

Delivery : Region / State Code

  • Template: Splash\Templates\Accounting\Delivery\RegionCode::class
  • Microdata: https://schema.org/deliveryAddress → addressRegion
shippingAddress__addressCountry
string <country> ([DA] Country ISO code)

Delivery : Country ISO code

  • Template: Splash\Templates\Accounting\Delivery\CountryCode::class
  • Microdata: https://schema.org/deliveryAddress → addressCountry
shippingAddress__duns
string <varchar> ([DA] Company Number / DUNS)

Delivery : Company Number / DUNS

  • Template: Splash\Templates\Accounting\Delivery\Duns::class
  • Microdata: https://schema.org/deliveryAddress → duns
shippingAddress__taxId
string <varchar> ([DA] Tax ID)

Delivery : Tax ID

  • Template: Splash\Templates\Accounting\Delivery\TaxId::class
  • Microdata: https://schema.org/deliveryAddress → taxID
shippingAddress__vatId
string <varchar> ([DA] VAT Number)

Delivery : VAT Number

  • Template: Splash\Templates\Accounting\Delivery\VatId::class
  • Microdata: https://schema.org/deliveryAddress → vatID
addressCountryName
string <varchar> (Country name)

The country name.

  • Template: Splash\Templates\Address\PostalAddress\CountryName::class
  • Microdata: http://schema.org/PostalAddress → addressCountryName
{
  • "username": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "email": "user@example.com",
  • "phone": "+33612345678",
  • "mobilePhone": "+33612345678",
  • "fax": "+33612345678",
  • "gender": "m",
  • "genderName": "string",
  • "url": "string",
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "company": "string",
  • "streetAddress": "string",
  • "postOfficeBoxNumber": "string",
  • "extendedAddress": "string",
  • "postalCode": "string",
  • "addressLocality": "string",
  • "addressRegion": "string",
  • "addressCountry": "string",
  • "duns": "string",
  • "taxId": "string",
  • "vatId": "string",
  • "billingAddressId": "426::Address",
  • "shippingAddressId": "21::Address",
  • "naics": "string",
  • "isicV4": "string",
  • "active": true,
  • "prospect": true,
  • "customer": true,
  • "supplier": true,
  • "useVat": true,
  • "newsletter": true,
  • "advertising": true,
  • "noEmail": true,
  • "noSms": true,
  • "mailingListName": "string",
  • "billingAddress__company": "string",
  • "billingAddress__firstname": "string",
  • "billingAddress__lastname": "string",
  • "billingAddress__email": "user@example.com",
  • "billingAddress__phone": "+33612345678",
  • "billingAddress__streetAddress": "string",
  • "billingAddress__postOfficeBoxNumber": "string",
  • "billingAddress__extendedAddress": "string",
  • "billingAddress__postalCode": "string",
  • "billingAddress__addressLocality": "string",
  • "billingAddress__addressRegion": "string",
  • "billingAddress__addressCountry": "string",
  • "billingAddress__duns": "string",
  • "billingAddress__taxId": "string",
  • "billingAddress__vatId": "string",
  • "shippingAddress__company": "string",
  • "shippingAddress__firstname": "string",
  • "shippingAddress__lastname": "string",
  • "shippingAddress__email": "user@example.com",
  • "shippingAddress__phone": "+33612345678",
  • "shippingAddress__streetAddress": "string",
  • "shippingAddress__postOfficeBoxNumber": "string",
  • "shippingAddress__extendedAddress": "string",
  • "shippingAddress__postalCode": "string",
  • "shippingAddress__addressLocality": "string",
  • "shippingAddress__addressRegion": "string",
  • "shippingAddress__addressCountry": "string",
  • "shippingAddress__duns": "string",
  • "shippingAddress__taxId": "string",
  • "shippingAddress__vatId": "string",
  • "addressCountryName": "string"
}

List ThirdParty

Read objects list — rows only carry fields flagged In List.

The server appends a meta entry to the result: { total, current } counters.

Request Body schema: application/json
required
filters
string or null

Text filter applied on searchable fields

object

Responses

Request samples

Content type
application/json
{
  • "filters": "string",
  • "params": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Read ThirdParty

Read object data — only requested fields are returned.

Request Body schema: application/json
required
id
required
string

Object identifier

fields
Array of strings

Ids of the fields to read

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": [
    ]
}

Response samples

Content type
application/json
{
  • "username": "string",
  • "lastname": "string",
  • "firstname": "string",
  • "email": "user@example.com",
  • "phone": "+33612345678",
  • "mobilePhone": "+33612345678",
  • "fax": "+33612345678",
  • "gender": "m",
  • "genderName": "string",
  • "url": "string",
  • "dateCreated": "2026-07-24 11:55:40",
  • "dateModified": "2026-07-24 11:55:40",
  • "objectId": "string",
  • "syncDateCreated": "2026-07-24 11:55:40",
  • "originNodeId": "string",
  • "originNodeName": "string",
  • "presence": "string",
  • "company": "string",
  • "streetAddress": "string",
  • "postOfficeBoxNumber": "string",
  • "extendedAddress": "string",
  • "postalCode": "string",
  • "addressLocality": "string",
  • "addressRegion": "string",
  • "addressCountry": "string",
  • "duns": "string",
  • "taxId": "string",
  • "vatId": "string",
  • "billingAddressId": "426::Address",
  • "shippingAddressId": "21::Address",
  • "naics": "string",
  • "isicV4": "string",
  • "active": true,
  • "prospect": true,
  • "customer": true,
  • "supplier": true,
  • "useVat": true,
  • "newsletter": true,
  • "advertising": true,
  • "noEmail": true,
  • "noSms": true,
  • "mailingListName": "string",
  • "billingAddress__company": "string",
  • "billingAddress__firstname": "string",
  • "billingAddress__lastname": "string",
  • "billingAddress__email": "user@example.com",
  • "billingAddress__phone": "+33612345678",
  • "billingAddress__streetAddress": "string",
  • "billingAddress__postOfficeBoxNumber": "string",
  • "billingAddress__extendedAddress": "string",
  • "billingAddress__postalCode": "string",
  • "billingAddress__addressLocality": "string",
  • "billingAddress__addressRegion": "string",
  • "billingAddress__addressCountry": "string",
  • "billingAddress__duns": "string",
  • "billingAddress__taxId": "string",
  • "billingAddress__vatId": "string",
  • "shippingAddress__company": "string",
  • "shippingAddress__firstname": "string",
  • "shippingAddress__lastname": "string",
  • "shippingAddress__email": "user@example.com",
  • "shippingAddress__phone": "+33612345678",
  • "shippingAddress__streetAddress": "string",
  • "shippingAddress__postOfficeBoxNumber": "string",
  • "shippingAddress__extendedAddress": "string",
  • "shippingAddress__postalCode": "string",
  • "shippingAddress__addressLocality": "string",
  • "shippingAddress__addressRegion": "string",
  • "shippingAddress__addressCountry": "string",
  • "shippingAddress__duns": "string",
  • "shippingAddress__taxId": "string",
  • "shippingAddress__vatId": "string",
  • "addressCountryName": "string"
}

Write ThirdParty

Create or update object data — read-only fields are not writable and hidden from this request.

Request Body schema: application/json
required
id
string or null

Object identifier — null to create a new object

required
object (ThirdParty)

Sample Customer Object to Expose Splash Scopes: identity, identifiers, marketing flags & owned addresses.

Addresses Modes

Three address levels may coexist on a Customer:

Block Fields Microdata Usage
Generic unprefixed (streetAddress, ...) schema.org/PostalAddress Main — billing details by convention
Billing Contact billingAddress__* schema.org/billingAddress Optional dedicated billing contact
Shipping Contact shippingAddress__* schema.org/deliveryAddress Optional dedicated delivery contact

Contacts may also be exposed as standalone Address objects, linked from the Customer via billingAddressId / shippingAddressId (objectid::Address).

  • Preferred: sync the generic block on the Customer, and manage the optional contacts as standalone Address objects, using the objectid links.
  • One-shot: expose the billingAddress__* / shippingAddress__* blocks to sync the Customer and both contacts in a single call.

Avoid mixing both write channels (objectid link and __ block) for the same address in a single request.

Identifiers

Company identifiers follow schema.org semantics: duns (SIREN in France), vatId (EU VAT number), taxId (national tax ID), naics & isicV4 (activity classifications).

Primary Key

email is the recommended primary field for customers, but any unique field may fit, depending on the connector context (i.e. phone number).

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "fields": {
    }
}

Response samples

Content type
application/json
"string"

Delete ThirdParty

Delete an object.

Request Body schema: application/json
required
id
required
string

Object identifier

Responses

Request samples

Content type
application/json
{
  • "id": "string"
}

Response samples

Content type
application/json
true