{ "openapi": "3.0.3", "info": { "title": "Splash Php Client Module 3.0.0", "description": "Splash Open-Source & Universal Synchronisation WebService.", "version": "3.0.0", "x-splash-server": { "shortdesc": "Splash Php Client Module 3.0.0", "longdesc": "Splash Open-Source & Universal Synchronisation WebService.", "logourl": "://", "scopes": { "Splash.Scopes.Product.Provider": "Splash.Scopes.Product.Provider", "Splash.Scopes.Product.VariantsProvider": "Splash.Scopes.Product.VariantsProvider", "Splash.Scopes.Product.VariantsReceiver": "Splash.Scopes.Product.VariantsReceiver", "Splash.Scopes.Product.GalleryProvider": "Splash.Scopes.Product.GalleryProvider", "Splash.Scopes.Product.GalleryReceiver": "Splash.Scopes.Product.GalleryReceiver", "Splash.Scopes.ThirdParty.Provider": "Splash.Scopes.ThirdParty.Provider" }, "servertype": "Symfony PHP Framework", "serverurl": "localhost:8000", "moduleauthor": "Splash Official ", "moduleversion": "3.0.0" } }, "tags": [ { "name": "Address", "description": "- **Type:** `AddressMapper`\n- **Icon:** `fa fa-envelope-o`\n\nSample Address Object to Expose Splash Scopes\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "Invoice", "description": "- **Type:** `InvoiceMapper`\n- **Icon:** `fa fa-file-text-o`\n\nSample Invoice Object including all Generic Fields Definitions:\ngeneric fields, invoice items, payments & accounting relations.\n\n#### Addresses Modes\n\nSale documents expose the customer link plus two denormalized address\nblocks, usually snapshots of the contacts taken at sale time:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Customer** | `thirdParty__*` | base ThirdParty microdata | Customer snapshot |\n| **Billing** | `billingAddress__*` | `schema.org/billingAddress` | Billing contact at sale time |\n| **Shipping** | `shippingAddress__*` | `schema.org/deliveryAddress` | Delivery contact at sale time |\n\n#### Payments\n\nSettlements are exposed as a **list**: an invoice may be paid by several\npayments, each one carrying its method code, date, transaction id & amount.\nTracking fields are NOT exposed here: parcels belong to the Order.\n\n#### Recommended Sync Strategy\n\n- **Preferred**: work with the `thirdPartyId`, `billingAddressId` &\n`shippingAddressId` object links (`objectid`), and sync Customer / Address\nobjects separately.\n- Address blocks are best treated as **read-only snapshots**: use them to\nenrich the remote document display, not as a write channel.\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "Order", "description": "- **Type:** `OrderMapper`\n- **Icon:** `fa fa-shopping-cart`\n\nSample Order Object including all Generic Fields Definitions:\ngeneric fields, order items, statuses & accounting relations.\n\n#### Addresses Modes\n\nSale documents expose the customer link plus two denormalized address\nblocks, usually snapshots of the contacts taken at sale time:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Customer** | `thirdParty__*` | base ThirdParty microdata | Customer snapshot |\n| **Billing** | `billingAddress__*` | `schema.org/billingAddress` | Billing contact at sale time |\n| **Shipping** | `shippingAddress__*` | `schema.org/deliveryAddress` | Delivery contact at sale time |\n\nUnlike the Customer \u2014 where the generic address holds the billing /\nadministrative details \u2014 on sale documents (orders, invoices) the default\naddress is the **delivery** one: logistics comes first.\n\n#### Payments\n\nSettlements are exposed as a **list**: an order may be settled by several\npayments, each one carrying its method code, date, transaction id & amount.\n\n#### Recommended Sync Strategy\n\n- **Preferred**: work with the `thirdPartyId`, `billingAddressId` &\n`shippingAddressId` object links (`objectid`), and sync Customer / Address\nobjects separately.\n- Address blocks are best treated as **read-only snapshots**: use them to\nenrich the remote document display, not as a write channel.\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "Product", "description": "- **Type:** `ProductMapper`\n- **Icon:** `fa fa-cubes`\n\nSplash\\Core\\Models\\AbstractObject\n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "Quotation", "description": "- **Type:** `QuotationMapper`\n- **Icon:** `fa fa-file-o`\n\nSample Quotation Object: commercial offer sent to a customer,\nsharing the generic accounting fields of the Order object.\n\n#### Lifecycle\n\nThe normalized `status` is the single source of truth; `isDraft`,\n`isValidated`, `isSigned`, `isRefused` and `isCanceled` are **read-only\nprojections** of it, exposed so connectors can filter without decoding\nthe status code.\n\n#### Validity\n\n`validityDate` closes the offer: prices and availability are no longer\nguaranteed afterwards, and the quotation usually moves to an expired status.\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "SupplierInvoice", "description": "- **Type:** `SupplierInvoiceMapper`\n- **Icon:** `fa fa-file-text`\n\nSample Supplier Invoice Object: purchase counterpart of the\nInvoice object, built from the very same field templates.\n\n#### Purchase vs Sale\n\nThe ThirdParty link points to the **supplier**, and references are reversed:\n`refInternal` is our own booking reference, `refCustomer` is the invoice\nnumber issued by the supplier.\n\n#### Payments\n\nSettlements are exposed as a **list**: an invoice may be paid by several\npayments, each one carrying its method code, date, transaction id & amount.\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "SupplierOrder", "description": "- **Type:** `SupplierOrderMapper`\n- **Icon:** `fa fa-truck`\n\nSample Supplier Order Object: purchase counterpart of the\nOrder object, sharing the very same generic accounting fields.\n\n#### Purchase vs Sale\n\nThe ThirdParty link points to the **supplier**, and references are reversed:\n`refInternal` is our own purchase order reference, `refCustomer` is the\nreference of this order on the supplier side.\n\n#### Receptions\n\nGoods receiving is exposed as a **list** of `receptions@*`, parallel to the\nitems list: one entry per product, comparing the ordered quantity with the\nquantity actually received. Read-only, the warehouse application owns it.\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" }, { "name": "ThirdParty", "description": "- **Type:** `ThirdPartyMapper`\n- **Icon:** `fa fa-user`\n\nSample Customer Object to Expose Splash Scopes: identity,\nidentifiers, marketing flags & owned addresses.\n\n#### Addresses Modes\n\nThree address levels may coexist on a Customer:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Generic** | unprefixed (`streetAddress`, ...) | `schema.org/PostalAddress` | Main \u2014 billing details by convention |\n| **Billing Contact** | `billingAddress__*` | `schema.org/billingAddress` | Optional dedicated billing contact |\n| **Shipping Contact** | `shippingAddress__*` | `schema.org/deliveryAddress` | Optional dedicated delivery contact |\n\nContacts may also be exposed as standalone Address objects, linked from the\nCustomer via `billingAddressId` / `shippingAddressId` (`objectid::Address`).\n\n#### Recommended Sync Strategy\n\n- **Preferred**: sync the generic block on the Customer, and manage the\noptional contacts as standalone Address objects, using the `objectid`\nlinks.\n- **One-shot**: expose the `billingAddress__*` / `shippingAddress__*`\nblocks to sync the Customer and both contacts in a single call.\n\nAvoid mixing both write channels (`objectid` link and `__` block) for the\nsame address in a single request.\n\n#### Identifiers\n\nCompany identifiers follow `schema.org` semantics: `duns` (SIREN in France),\n`vatId` (EU VAT number), `taxId` (national tax ID), `naics` & `isicV4`\n(activity classifications).\n\n#### Primary Key\n\n`email` is the recommended primary field for customers, but any unique\nfield may fit, depending on the connector context (i.e. phone number).\n \n\n### Configuration\n\n| Action | Allowed | Push | Pull |\n|--------|:-------:|:----:|:----:|\n| Create | \u2705 | \u2705 | \u2705 |\n| Update | \u2705 | \u2705 | \u2705 |\n| Delete | \u2705 | \u2705 | \u2705 |\n\n" } ], "paths": { "/address/list": { "post": { "tags": [ "Address" ], "summary": "List Address", "operationId": "listAddress", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressListItem" } } } } } } } }, "/address/get": { "post": { "tags": [ "Address" ], "summary": "Read Address", "operationId": "getAddress", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } } } } } }, "/address/set": { "post": { "tags": [ "Address" ], "summary": "Write Address", "operationId": "setAddress", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/Address" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/address/delete": { "post": { "tags": [ "Address" ], "summary": "Delete Address", "operationId": "deleteAddress", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/invoice/list": { "post": { "tags": [ "Invoice" ], "summary": "List Invoice", "operationId": "listInvoice", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceListItem" } } } } } } } }, "/invoice/get": { "post": { "tags": [ "Invoice" ], "summary": "Read Invoice", "operationId": "getInvoice", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } } } } }, "/invoice/set": { "post": { "tags": [ "Invoice" ], "summary": "Write Invoice", "operationId": "setInvoice", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/Invoice" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/invoice/delete": { "post": { "tags": [ "Invoice" ], "summary": "Delete Invoice", "operationId": "deleteInvoice", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/order/list": { "post": { "tags": [ "Order" ], "summary": "List Order", "operationId": "listOrder", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderListItem" } } } } } } } }, "/order/get": { "post": { "tags": [ "Order" ], "summary": "Read Order", "operationId": "getOrder", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } } } } }, "/order/set": { "post": { "tags": [ "Order" ], "summary": "Write Order", "operationId": "setOrder", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/Order" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/order/delete": { "post": { "tags": [ "Order" ], "summary": "Delete Order", "operationId": "deleteOrder", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/product/list": { "post": { "tags": [ "Product" ], "summary": "List Product", "operationId": "listProduct", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductListItem" } } } } } } } }, "/product/get": { "post": { "tags": [ "Product" ], "summary": "Read Product", "operationId": "getProduct", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Product" } } } } } } }, "/product/set": { "post": { "tags": [ "Product" ], "summary": "Write Product", "operationId": "setProduct", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/Product" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/product/delete": { "post": { "tags": [ "Product" ], "summary": "Delete Product", "operationId": "deleteProduct", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/quotation/list": { "post": { "tags": [ "Quotation" ], "summary": "List Quotation", "operationId": "listQuotation", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/QuotationListItem" } } } } } } } }, "/quotation/get": { "post": { "tags": [ "Quotation" ], "summary": "Read Quotation", "operationId": "getQuotation", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quotation" } } } } } } }, "/quotation/set": { "post": { "tags": [ "Quotation" ], "summary": "Write Quotation", "operationId": "setQuotation", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/Quotation" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/quotation/delete": { "post": { "tags": [ "Quotation" ], "summary": "Delete Quotation", "operationId": "deleteQuotation", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/supplierinvoice/list": { "post": { "tags": [ "SupplierInvoice" ], "summary": "List SupplierInvoice", "operationId": "listSupplierInvoice", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceListItem" } } } } } } } }, "/supplierinvoice/get": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Read SupplierInvoice", "operationId": "getSupplierInvoice", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoice" } } } } } } }, "/supplierinvoice/set": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Write SupplierInvoice", "operationId": "setSupplierInvoice", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/SupplierInvoice" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/supplierinvoice/delete": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Delete SupplierInvoice", "operationId": "deleteSupplierInvoice", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/supplierorder/list": { "post": { "tags": [ "SupplierOrder" ], "summary": "List SupplierOrder", "operationId": "listSupplierOrder", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierOrderListItem" } } } } } } } }, "/supplierorder/get": { "post": { "tags": [ "SupplierOrder" ], "summary": "Read SupplierOrder", "operationId": "getSupplierOrder", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierOrder" } } } } } } }, "/supplierorder/set": { "post": { "tags": [ "SupplierOrder" ], "summary": "Write SupplierOrder", "operationId": "setSupplierOrder", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/SupplierOrder" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/supplierorder/delete": { "post": { "tags": [ "SupplierOrder" ], "summary": "Delete SupplierOrder", "operationId": "deleteSupplierOrder", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } }, "/thirdparty/list": { "post": { "tags": [ "ThirdParty" ], "summary": "List ThirdParty", "operationId": "listThirdParty", "description": "Read objects list \u2014 rows only carry fields flagged `In List`.\n\nThe server appends a `meta` entry to the result: `{ total, current }` counters.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "filters": { "type": "string", "nullable": true, "description": "Text filter applied on searchable fields" }, "params": { "type": "object", "properties": { "max": { "type": "integer", "description": "Maximum number of results" }, "offset": { "type": "integer", "description": "List start offset" }, "sortfield": { "type": "string", "description": "Field id used to sort the list" }, "sortorder": { "type": "string", "enum": [ "ASC", "DESC" ] } } } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThirdPartyListItem" } } } } } } } }, "/thirdparty/get": { "post": { "tags": [ "ThirdParty" ], "summary": "Read ThirdParty", "operationId": "getThirdParty", "description": "Read object data \u2014 only requested fields are returned.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" }, "fields": { "type": "array", "items": { "type": "string" }, "description": "Ids of the fields to read" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdParty" } } } } } } }, "/thirdparty/set": { "post": { "tags": [ "ThirdParty" ], "summary": "Write ThirdParty", "operationId": "setThirdParty", "description": "Create or update object data \u2014 read-only fields are not writable and hidden from this request.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fields" ], "properties": { "id": { "type": "string", "nullable": true, "description": "Object identifier \u2014 `null` to create a new object" }, "fields": { "$ref": "#/components/schemas/ThirdParty" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "string", "description": "Identifier of the created or updated object" } } } }, "500": { "description": "Write failure \u2014 the server answers `null`. Check `Splash::log()` messages for error details.", "content": { "application/json": { "schema": { "nullable": true, "description": "Always `null` on write failure" } } } } } } }, "/thirdparty/delete": { "post": { "tags": [ "ThirdParty" ], "summary": "Delete ThirdParty", "operationId": "deleteThirdParty", "description": "Delete an object.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "description": "Object identifier" } } } } } }, "responses": { "200": { "description": "Task data payload", "content": { "application/json": { "schema": { "type": "boolean", "description": "True when the object was deleted" } } } } } } } }, "components": { "schemas": { "SplashPrice": { "type": "object", "title": "Splash Price", "description": "Price structure with tax details and currency", "properties": { "ht": { "type": "number", "description": "Tax excluded amount" }, "ttc": { "type": "number", "description": "Tax included amount" }, "tax": { "type": "number", "description": "Tax amount" }, "vat": { "type": "number", "description": "VAT rate (percent)" }, "base": { "type": "integer", "enum": [ 0, 1 ], "description": "Price base: 0 = tax excluded, 1 = tax included" }, "code": { "type": "string", "description": "Currency ISO code" }, "symbol": { "type": "string", "description": "Currency symbol" }, "name": { "type": "string", "description": "Currency name" } } }, "SplashFile": { "type": "object", "title": "Splash File", "description": "File structure with checksum for synchronization", "properties": { "name": { "type": "string", "description": "Human readable file name" }, "filename": { "type": "string", "description": "File name with extension" }, "path": { "type": "string", "description": "File path or identifier on server" }, "url": { "type": "string", "format": "uri", "description": "Public url, if available" }, "md5": { "type": "string", "description": "File contents checksum" }, "size": { "type": "integer", "description": "File size in bytes" } } }, "SplashImage": { "title": "Splash Image", "description": "Image structure: a Splash File with dimensions", "allOf": [ { "$ref": "#/components/schemas/SplashFile" }, { "type": "object", "properties": { "width": { "type": "integer", "description": "Image width in pixels" }, "height": { "type": "integer", "description": "Image height in pixels" } } } ] }, "Address": { "type": "object", "title": "Address", "description": "Sample Address Object to Expose Splash Scopes", "x-splash-type": "Address", "properties": { "alias": { "type": "string", "title": "Alias", "description": "Address Alias\n\n- **Template:** `Splash\\Templates\\Address\\Core\\Alias::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `name`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "name", "x-technical-description": "Short label or alias used to identify an address within a ThirdParty. Typically user-defined (e.g. 'Home', 'Office', 'Warehouse Paris'). Mapped to schema.org PostalAddress/name. This is NOT the contact name or company name, it is the address label. Most connectors use this as a display name in address lists. May be required by some connectors to create a new address." }, "type": { "type": "string", "title": "Address Type", "description": "Normalized Address Type\n\n- **Template:** `Splash\\Templates\\Address\\Core\\Type::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `contactType`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "contactType", "enum": [ "billing", "delivery", "other" ], "x-technical-description": "Normalized address type code, tells what kind of address this is. Mapped to schema.org ContactPoint/contactType. Accepted values are Splash normalized: 'billing', 'delivery', 'other' (from AddressType dictionary). The connector must convert its local address type codes to/from these normalized values using AddressType::toSplash() and AddressType::toApp(). Use the ALIAS template for the free user-defined address label." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Parent ThirdParty", "description": "ThirdParty linked to this Address\n\n- **Template:** `Splash\\Templates\\Address\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this address to its parent ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID. This field establishes the parent-child relationship between ThirdParty and Address objects. When reading, the connector must return the Splash-encoded ID of the parent ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference.", "example": "759::ThirdParty" }, "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "company": { "type": "string", "title": "Company", "description": "Company Name, leave empty for individuals\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Name::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `legalName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "legalName", "x-technical-description": "Company name of the address contact, for Address definitions ONLY: postal address, billing address, delivery address. Company name ONLY: leave EMPTY when the contact is an individual. Mapped to schema.org Organization/legalName \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Name template instead (primary identification name, required, indexed and listed by default)." }, "alternateName": { "type": "string", "title": "Alternative name / Full name", "description": "Address contact alternative or complete name, all in one.\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\AlternateName::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "alternateName", "x-technical-description": "Alternative or full name of the address contact, for Address definitions ONLY: postal address, billing address, delivery address. Typically a composite of firstname + lastname, used when the application does not store them as separate fields. Mapped to schema.org PostalAddress/alternateName. Grouped under 'Address' by convention." }, "firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "thirdParty__username": { "type": "string", "title": "User name", "description": "ThirdParty or Company Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Name::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `legalName`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "legalName", "x-technical-description": "Primary identification name of the ThirdParty. For a company: the legal name (e.g. 'Acme Corp'). For an individual: the username or display name. Mapped to schema.org Organization/legalName. This field is required, indexed, listed and logged by default. It is the main identifier shown in lists and search results. Also available via AddressFields for address contact identification." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "thirdParty__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Person Phone\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Phone::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "addressCountryName": { "type": "string", "title": "Country name", "description": "The country name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryName::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountryName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountryName", "x-technical-description": "Human-readable country name. Read-only field, derived from the COUNTRY code by the connector. Mapped to schema.org PostalAddress/addressCountryName. Grouped under 'Address' in field definitions. This field is never synchronized, it is purely informational. To change the country, write to the COUNTRY (code) field instead." } }, "required": [ "alias" ] }, "AddressListItem": { "type": "object", "title": "Address (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "alias": { "type": "string", "title": "Alias" }, "type": { "type": "string", "title": "Address Type" } } }, "Invoice": { "type": "object", "title": "Invoice", "description": "Sample Invoice Object including all Generic Fields Definitions:\ngeneric fields, invoice items, payments & accounting relations.\n\n#### Addresses Modes\n\nSale documents expose the customer link plus two denormalized address\nblocks, usually snapshots of the contacts taken at sale time:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Customer** | `thirdParty__*` | base ThirdParty microdata | Customer snapshot |\n| **Billing** | `billingAddress__*` | `schema.org/billingAddress` | Billing contact at sale time |\n| **Shipping** | `shippingAddress__*` | `schema.org/deliveryAddress` | Delivery contact at sale time |\n\n#### Payments\n\nSettlements are exposed as a **list**: an invoice may be paid by several\npayments, each one carrying its method code, date, transaction id & amount.\nTracking fields are NOT exposed here: parcels belong to the Order.\n\n#### Recommended Sync Strategy\n\n- **Preferred**: work with the `thirdPartyId`, `billingAddressId` &\n`shippingAddressId` object links (`objectid`), and sync Customer / Address\nobjects separately.\n- Address blocks are best treated as **read-only snapshots**: use them to\nenrich the remote document display, not as a write channel.\n ", "x-splash-type": "Invoice", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "currency": { "type": "string", "format": "currency", "title": "Currency", "description": "Currency of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\Currency::class`\n- **Microdata:** `https://schema.org/PriceSpecification` \u2192 `priceCurrency`", "x-splash-type": "currency", "x-schema-org-itemtype": "https://schema.org/PriceSpecification", "x-schema-org-itemprop": "priceCurrency", "x-technical-description": "Currency of ALL amounts of the document: totals, line unit prices and payments are expressed in it, no amount carries its own currency. Splash type is 'currency', an ISO 4217 code (EUR, USD, GBP...). Usually read-only, the currency being chosen when the document is created and never changed afterwards. Mapped to schema.org PriceSpecification/priceCurrency (https scheme: new field, no legacy pairing to preserve)." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer of the document (order / invoice)\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this accounting document to its customer ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID, on every accounting document. When reading, the connector must return the Splash-encoded ID of the customer ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference. MIGRATION: legacy connectors tag this field as Organization/ID on orders but as Invoice/customer on invoices, credit notes & quotations. This is the very same data, so this template unifies them: on invoicing documents, replace the legacy Invoice/customer metadata by this one.", "example": "430::ThirdParty" }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "582::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "311::Address" }, "date": { "type": "string", "format": "date", "title": "Invoice Date", "description": "Official issuing date of the invoice\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\Date::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDate", "x-technical-description": "Official issuing date of the invoice, the one printed on the document and used for accounting periods. Not the date the related order was placed. Format: Splash date (Y-m-d). Mapped to schema.org Order/orderDate \u2014 same microdata as the Order Date template, so both documents pair on their own date. Required and listed by default.", "example": "2026-09-10" }, "paymentDueDate": { "type": "string", "format": "date", "title": "Payment Due Date", "description": "Date the payment is expected\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\PaymentDueDate::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `paymentDueDate`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "paymentDueDate", "x-technical-description": "Date the payment of the invoice is due, computed by the accounting application from the invoice date and the payment term of the customer. Used to detect overdue invoices. Format: Splash date (Y-m-d). Mapped to schema.org Invoice/paymentDueDate.", "example": "2026-09-10" }, "refInternal": { "type": "string", "title": "Internal Ref.", "description": "Unique internal invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefInternal::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `name`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "name", "x-technical-description": "Internal unique reference of the invoice, generated by the remote application (e.g. 'FA2024-0001'). Mapped to schema.org Invoice/name. Read-only by convention. Indexed and listed by default." }, "refCustomer": { "type": "string", "title": "Customer Ref.", "description": "Customer-side invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefCustomer::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `confirmationNumber`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "confirmationNumber", "x-technical-description": "Reference of the invoice on the customer side (e.g. a confirmation number). Mapped to schema.org Invoice/confirmationNumber. Indexed and listed by default." }, "refExternal": { "type": "string", "title": "External Ref.", "description": "External invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefExternal::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `alternateName`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "alternateName", "x-technical-description": "External reference of the invoice, typically coming from a third-party system. Mapped to schema.org Invoice/alternateName. Indexed and listed by default." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Line Type", "description": "Normalized type of the line\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Type::class`\n- **Microdata:** `https://schema.org/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "https://schema.org/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ], "x-technical-description": "Qualifies WHAT the accounting line is, so that the receiving application does not have to guess it from the line label. Accepted values are Splash normalized codes from the AccountLineType dictionary: 'product' (sold product or service), 'shipping' (delivery charges), 'fee' (extra charge or global discount), 'option' (optional line, qty = 0 & price != 0), 'comment' (free text, qty = 1 & price = 0). An EMPTY value means a regular product line, so connectors that ignore this field keep working as before. Mapped to schema.org OrderItem/additionalType (https scheme: new field, no legacy pairing to preserve). Final type is varchar@list." }, "description": { "type": "string", "title": "Description", "description": "Line description\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Description::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "description", "x-technical-description": "Free-text description of the accounting line item (typically the product short description). Mapped to schema.org partOfInvoice/description. Final type is varchar@list." }, "productSku": { "type": "string", "title": "Product SKU", "description": "SKU of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product attached to the accounting line. Mapped to schema.org Product/sku. Final type is varchar@list." }, "productName": { "type": "string", "title": "Product Name", "description": "Name of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Name of the product attached to the accounting line (typically a snapshot of the product name at the time of sale). Mapped to schema.org Product/name. Final type is varchar@list." }, "productMpn": { "type": "string", "title": "Supplier Ref.", "description": "Supplier reference (MPN) of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductMpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number (MPN) of the product attached to the accounting line. Mapped to schema.org Product/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Quantity", "description": "Line quantity\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Quantity::class`\n- **Microdata:** `http://schema.org/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/QuantitativeValue", "x-schema-org-itemprop": "value", "x-technical-description": "Quantity of the accounting line item. Mapped to schema.org QuantitativeValue/value. Final type is int@list." }, "discount": { "type": "number", "title": "Discount (%)", "description": "Discount applied to the line, in percent\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Discount::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "discount", "x-technical-description": "Percentage discount applied to the accounting line item. Mapped to schema.org Order/discount. Final type is double@list." }, "vatCode": { "type": "string", "title": "VAT Code", "description": "Code or name of the applicable VAT rate\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\VatCode::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName", "x-technical-description": "Code or name of the VAT rate applied to the accounting line item (e.g. '20.0', 'TVA20', 'std'). Mapped to schema.org PriceSpecification/valueAddedTaxName. Final type is varchar@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product ID", "description": "Splash ID of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductId::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash Object ID referencing the Product attached to the accounting line. Mapped to schema.org Product/productID. Final type is objectid::Product@list.", "example": "736::Product" }, "options": { "type": "string", "title": "Options", "description": "Line details (options, attributes, ...)\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Options::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "options", "x-technical-description": "Line item options as an inline list of strings, one entry per visible option, formatted as 'key: value' (product variation attributes, personalization, add-ons, ...). Typically extracted from order line meta data by the connector. This field is read-only: options are informative and never written back. Mapped to schema.org partOfInvoice/options. Final type is inline@list." }, "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Unit Price", "description": "Line unit price\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\UnitPrice::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Unit price of the accounting line item, expressed as a Splash price block (amount, VAT, currency, etc.). Mapped to schema.org PriceSpecification/price. Final type is price@list.", "example": { "base": 0, "ht": 55.79, "vat": 20, "tax": 11.16, "ttc": 66.95, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } } } } }, "payments": { "type": "array", "title": "Payments", "x-splash-list": "payments", "items": { "type": "object", "properties": { "mode": { "type": "string", "title": "Payment Method", "description": "Method of the payment\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentMode::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `PaymentMethod`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "PaymentMethod", "enum": [ "ByBankTransferInAdvance", "CheckInAdvance", "Cash", "CreditCard", "PayPal" ], "x-technical-description": "Method used to settle this payment. Always a CODE, never a human readable label. Recommended values are the Splash normalized codes of the PaymentMethods dictionary (GoodRelations vocabulary: 'ByBankTransferInAdvance', 'CheckInAdvance', 'Cash', 'COD', 'ByInvoice', 'DirectDebit', 'CreditCard', 'PayPal'...), but any application specific code is accepted, depending on the customer configuration. Allowed values are exposed via SPL\\Choices. Mapped to schema.org Invoice/PaymentMethod (capital P: historical Splash mapping shared by ALL existing connectors). List field: a document may be settled by several payments: the group is carried by the list itself." }, "date": { "type": "string", "format": "date@list", "title": "Date", "description": "Date the payment was received\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentDate::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `validFrom`", "x-splash-type": "date@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "validFrom", "x-technical-description": "Date the payment was received / cashed. Splash type is a LIST of 'date', formatted as YYYY-MM-DD. Mapped to schema.org PaymentChargeSpecification/validFrom. Usually read-only, the date being set by the accounting application when the payment is registered. List field: a document may be settled by several payments: the group is carried by the list itself.", "example": "2026-09-10" }, "number": { "type": "string", "title": "Transaction ID", "description": "Reference of the payment transaction\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentNumber::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `paymentMethodId`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "paymentMethodId", "x-technical-description": "Reference identifying the payment transaction: bank transaction id, check number, payment gateway reference... Mapped to schema.org Invoice/paymentMethodId \u2014 historical Splash mapping shared by ALL existing connectors, kept as-is even though the itemprop name suggests a method rather than a transaction. Same itemprop as the document level PaymentMethod template (Misc), without ambiguity: this one is a list field. List field: a document may be settled by several payments: the group is carried by the list itself." }, "amount": { "type": "number", "title": "Amount", "description": "Received amount, taxes included\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentAmount::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `price`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Amount of this payment, taxes included, in the document currency. Splash type is a LIST of 'double': raw amounts without currency, unlike 'price' fields. Mapped to schema.org PaymentChargeSpecification/price. The sum of all payments of a document is compared to its total to compute the paid / due status. List field: a document may be settled by several payments: the group is carried by the list itself." } } } } }, "required": [ "date", "refCustomer" ] }, "InvoiceListItem": { "type": "object", "title": "Invoice (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "date": { "type": "string", "format": "date", "title": "Invoice Date" }, "refInternal": { "type": "string", "title": "Internal Ref." }, "refCustomer": { "type": "string", "title": "Customer Ref." }, "refExternal": { "type": "string", "title": "External Ref." } } }, "Order": { "type": "object", "title": "Order", "description": "Sample Order Object including all Generic Fields Definitions:\ngeneric fields, order items, statuses & accounting relations.\n\n#### Addresses Modes\n\nSale documents expose the customer link plus two denormalized address\nblocks, usually snapshots of the contacts taken at sale time:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Customer** | `thirdParty__*` | base ThirdParty microdata | Customer snapshot |\n| **Billing** | `billingAddress__*` | `schema.org/billingAddress` | Billing contact at sale time |\n| **Shipping** | `shippingAddress__*` | `schema.org/deliveryAddress` | Delivery contact at sale time |\n\nUnlike the Customer \u2014 where the generic address holds the billing /\nadministrative details \u2014 on sale documents (orders, invoices) the default\naddress is the **delivery** one: logistics comes first.\n\n#### Payments\n\nSettlements are exposed as a **list**: an order may be settled by several\npayments, each one carrying its method code, date, transaction id & amount.\n\n#### Recommended Sync Strategy\n\n- **Preferred**: work with the `thirdPartyId`, `billingAddressId` &\n`shippingAddressId` object links (`objectid`), and sync Customer / Address\nobjects separately.\n- Address blocks are best treated as **read-only snapshots**: use them to\nenrich the remote document display, not as a write channel.\n ", "x-splash-type": "Order", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "currency": { "type": "string", "format": "currency", "title": "Currency", "description": "Currency of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\Currency::class`\n- **Microdata:** `https://schema.org/PriceSpecification` \u2192 `priceCurrency`", "x-splash-type": "currency", "x-schema-org-itemtype": "https://schema.org/PriceSpecification", "x-schema-org-itemprop": "priceCurrency", "x-technical-description": "Currency of ALL amounts of the document: totals, line unit prices and payments are expressed in it, no amount carries its own currency. Splash type is 'currency', an ISO 4217 code (EUR, USD, GBP...). Usually read-only, the currency being chosen when the document is created and never changed afterwards. Mapped to schema.org PriceSpecification/priceCurrency (https scheme: new field, no legacy pairing to preserve)." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer of the document (order / invoice)\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this accounting document to its customer ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID, on every accounting document. When reading, the connector must return the Splash-encoded ID of the customer ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference. MIGRATION: legacy connectors tag this field as Organization/ID on orders but as Invoice/customer on invoices, credit notes & quotations. This is the very same data, so this template unifies them: on invoicing documents, replace the legacy Invoice/customer metadata by this one.", "example": "112::ThirdParty" }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "230::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "284::Address" }, "date": { "type": "string", "format": "date", "title": "Order Date", "description": "Date the order was placed\n\n- **Template:** `Splash\\Templates\\Order\\Core\\Date::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDate", "x-technical-description": "Date the order was placed. Format: Splash date (Y-m-d). Mapped to schema.org Order/orderDate. Required and listed by default.", "example": "2026-09-10" }, "refInternal": { "type": "string", "title": "Internal Ref.", "description": "Unique internal order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefInternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `name`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "name", "x-technical-description": "Internal unique reference of the order, generated by the remote application (e.g. 'CMD2024-0001'). Mapped to schema.org Order/name. Read-only by convention. Indexed and listed by default." }, "refCustomer": { "type": "string", "title": "Customer Ref.", "description": "Customer-side order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefCustomer::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderNumber`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderNumber", "x-technical-description": "Reference of the order on the customer side (e.g. a PO number). Mapped to schema.org Order/orderNumber. Indexed and listed by default." }, "refExternal": { "type": "string", "title": "External Ref.", "description": "External order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefExternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `alternateName`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "alternateName", "x-technical-description": "External reference of the order, typically coming from a third-party system (e.g. a marketplace order ID). Mapped to schema.org Order/alternateName. Indexed by default." }, "shippingMethod": { "type": "string", "title": "Shipping Method", "description": "Shipping method / carrier\n\n- **Template:** `Splash\\Templates\\Accounting\\Tracking\\ShippingMethod::class`\n- **Microdata:** `http://schema.org/ParcelDelivery` \u2192 `identifier`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/ParcelDelivery", "x-schema-org-itemprop": "identifier", "enum": [ "colissimo", "chronopost", "ups" ], "x-technical-description": "Identifier / code of the shipping carrier used to deliver the document (e.g. 'colissimo', 'chronopost'). Mapped to schema.org ParcelDelivery/identifier. Allowed values are connector-specific and exposed via SPL\\Choices. Use the ShippingMethodName template for the human readable carrier name. Grouped under 'Tracking' by convention." }, "trackingNumber": { "type": "string", "title": "Tracking Number", "description": "Parcel tracking number\n\n- **Template:** `Splash\\Templates\\Accounting\\Tracking\\TrackingNumber::class`\n- **Microdata:** `http://schema.org/ParcelDelivery` \u2192 `trackingNumber`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/ParcelDelivery", "x-schema-org-itemprop": "trackingNumber", "x-technical-description": "Tracking number of the parcel, provided by the carrier once the document is shipped. Mapped to schema.org ParcelDelivery/trackingNumber. Main writable field of the Tracking group: shipping applications push it back to the e-commerce application to notify the customer. When a document has several parcels, this field exposes the FIRST / main tracking number. Indexed by default. Grouped under 'Tracking' by convention." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "invoiceNumber": { "type": "string", "title": "Invoice Number", "description": "Number of the order's first invoice\n\n- **Template:** `Splash\\Templates\\Accounting\\Invoicing\\InvoiceNumber::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `invoiceNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "invoiceNumber", "x-technical-description": "Internal number / reference of the FIRST invoice attached to an order. An order may have multiple invoices: this field only exposes the first / main one. Usually read-only, the number being generated by the invoicing application. Mapped to schema.org Order/invoiceNumber. No group by convention." }, "invoicePdf": { "allOf": [ { "$ref": "#/components/schemas/SplashFile" } ], "title": "Invoice PDF", "description": "PDF of the order's first invoice\n\n- **Template:** `Splash\\Templates\\Accounting\\Invoicing\\InvoicePdf::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `invoicePdf`", "x-splash-type": "stream", "format": "stream", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "invoicePdf", "x-technical-description": "PDF file of the FIRST invoice attached to an order. Splash type is 'stream': file contents are downloaded on demand through the Splash files protocol, only the checksum is compared during synchronization. An order may have multiple invoices: this field only exposes the first / main one. Usually read-only, the PDF being generated by the invoicing application. Mapped to schema.org Order/invoicePdf. No group by convention." }, "shippingMethodName": { "type": "string", "title": "Carrier Name", "description": "Carrier name\n\n- **Template:** `Splash\\Templates\\Accounting\\Tracking\\ShippingMethodName::class`\n- **Microdata:** `http://schema.org/ParcelDelivery` \u2192 `provider`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ParcelDelivery", "x-schema-org-itemprop": "provider", "x-technical-description": "Human readable name of the shipping carrier used to deliver the document (e.g. 'Colissimo - 48h'). Mapped to schema.org ParcelDelivery/provider. Usually read-only, the name being defined by the carrier configuration. Use the ShippingMethod template for the machine readable carrier code. Grouped under 'Tracking' by convention." }, "trackingUrl": { "type": "string", "format": "url", "title": "Tracking Url", "description": "Carrier parcel tracking url\n\n- **Template:** `Splash\\Templates\\Accounting\\Tracking\\TrackingUrl::class`\n- **Microdata:** `http://schema.org/ParcelDelivery` \u2192 `trackingUrl`", "x-splash-type": "url", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ParcelDelivery", "x-schema-org-itemprop": "trackingUrl", "x-technical-description": "Public url to follow the parcel on the carrier website. Splash type is 'url', validated as a valid url. Mapped to schema.org ParcelDelivery/trackingUrl. Usually read-only: connectors build it from the carrier url template and the tracking number. When a document has several parcels, this field exposes the FIRST / main tracking url. Grouped under 'Tracking' by convention." }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Line Type", "description": "Normalized type of the line\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Type::class`\n- **Microdata:** `https://schema.org/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "https://schema.org/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ], "x-technical-description": "Qualifies WHAT the accounting line is, so that the receiving application does not have to guess it from the line label. Accepted values are Splash normalized codes from the AccountLineType dictionary: 'product' (sold product or service), 'shipping' (delivery charges), 'fee' (extra charge or global discount), 'option' (optional line, qty = 0 & price != 0), 'comment' (free text, qty = 1 & price = 0). An EMPTY value means a regular product line, so connectors that ignore this field keep working as before. Mapped to schema.org OrderItem/additionalType (https scheme: new field, no legacy pairing to preserve). Final type is varchar@list." }, "description": { "type": "string", "title": "Description", "description": "Line description\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Description::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "description", "x-technical-description": "Free-text description of the accounting line item (typically the product short description). Mapped to schema.org partOfInvoice/description. Final type is varchar@list." }, "productSku": { "type": "string", "title": "Product SKU", "description": "SKU of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product attached to the accounting line. Mapped to schema.org Product/sku. Final type is varchar@list." }, "productName": { "type": "string", "title": "Product Name", "description": "Name of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Name of the product attached to the accounting line (typically a snapshot of the product name at the time of sale). Mapped to schema.org Product/name. Final type is varchar@list." }, "productMpn": { "type": "string", "title": "Supplier Ref.", "description": "Supplier reference (MPN) of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductMpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number (MPN) of the product attached to the accounting line. Mapped to schema.org Product/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Quantity", "description": "Line quantity\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Quantity::class`\n- **Microdata:** `http://schema.org/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/QuantitativeValue", "x-schema-org-itemprop": "value", "x-technical-description": "Quantity of the accounting line item. Mapped to schema.org QuantitativeValue/value. Final type is int@list." }, "discount": { "type": "number", "title": "Discount (%)", "description": "Discount applied to the line, in percent\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Discount::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "discount", "x-technical-description": "Percentage discount applied to the accounting line item. Mapped to schema.org Order/discount. Final type is double@list." }, "vatCode": { "type": "string", "title": "VAT Code", "description": "Code or name of the applicable VAT rate\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\VatCode::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName", "x-technical-description": "Code or name of the VAT rate applied to the accounting line item (e.g. '20.0', 'TVA20', 'std'). Mapped to schema.org PriceSpecification/valueAddedTaxName. Final type is varchar@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product ID", "description": "Splash ID of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductId::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash Object ID referencing the Product attached to the accounting line. Mapped to schema.org Product/productID. Final type is objectid::Product@list.", "example": "22::Product" }, "options": { "type": "string", "title": "Options", "description": "Line details (options, attributes, ...)\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Options::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "options", "x-technical-description": "Line item options as an inline list of strings, one entry per visible option, formatted as 'key: value' (product variation attributes, personalization, add-ons, ...). Typically extracted from order line meta data by the connector. This field is read-only: options are informative and never written back. Mapped to schema.org partOfInvoice/options. Final type is inline@list." }, "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Unit Price", "description": "Line unit price\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\UnitPrice::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Unit price of the accounting line item, expressed as a Splash price block (amount, VAT, currency, etc.). Mapped to schema.org PriceSpecification/price. Final type is price@list.", "example": { "base": 0, "ht": 150.37, "vat": 20, "tax": 30.07, "ttc": 180.44, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } } } } }, "payments": { "type": "array", "title": "Payments", "x-splash-list": "payments", "items": { "type": "object", "properties": { "mode": { "type": "string", "title": "Payment Method", "description": "Method of the payment\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentMode::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `PaymentMethod`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "PaymentMethod", "enum": [ "ByBankTransferInAdvance", "CheckInAdvance", "Cash", "CreditCard", "PayPal" ], "x-technical-description": "Method used to settle this payment. Always a CODE, never a human readable label. Recommended values are the Splash normalized codes of the PaymentMethods dictionary (GoodRelations vocabulary: 'ByBankTransferInAdvance', 'CheckInAdvance', 'Cash', 'COD', 'ByInvoice', 'DirectDebit', 'CreditCard', 'PayPal'...), but any application specific code is accepted, depending on the customer configuration. Allowed values are exposed via SPL\\Choices. Mapped to schema.org Invoice/PaymentMethod (capital P: historical Splash mapping shared by ALL existing connectors). List field: a document may be settled by several payments: the group is carried by the list itself." }, "date": { "type": "string", "format": "date@list", "title": "Date", "description": "Date the payment was received\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentDate::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `validFrom`", "x-splash-type": "date@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "validFrom", "x-technical-description": "Date the payment was received / cashed. Splash type is a LIST of 'date', formatted as YYYY-MM-DD. Mapped to schema.org PaymentChargeSpecification/validFrom. Usually read-only, the date being set by the accounting application when the payment is registered. List field: a document may be settled by several payments: the group is carried by the list itself.", "example": "2026-09-10" }, "number": { "type": "string", "title": "Transaction ID", "description": "Reference of the payment transaction\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentNumber::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `paymentMethodId`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "paymentMethodId", "x-technical-description": "Reference identifying the payment transaction: bank transaction id, check number, payment gateway reference... Mapped to schema.org Invoice/paymentMethodId \u2014 historical Splash mapping shared by ALL existing connectors, kept as-is even though the itemprop name suggests a method rather than a transaction. Same itemprop as the document level PaymentMethod template (Misc), without ambiguity: this one is a list field. List field: a document may be settled by several payments: the group is carried by the list itself." }, "amount": { "type": "number", "title": "Amount", "description": "Received amount, taxes included\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentAmount::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `price`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Amount of this payment, taxes included, in the document currency. Splash type is a LIST of 'double': raw amounts without currency, unlike 'price' fields. Mapped to schema.org PaymentChargeSpecification/price. The sum of all payments of a document is compared to its total to compute the paid / due status. List field: a document may be settled by several payments: the group is carried by the list itself." } } } } }, "required": [ "date", "refCustomer" ] }, "OrderListItem": { "type": "object", "title": "Order (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "date": { "type": "string", "format": "date", "title": "Order Date" }, "refInternal": { "type": "string", "title": "Internal Ref." }, "refCustomer": { "type": "string", "title": "Customer Ref." } } }, "Product": { "type": "object", "title": "Product", "description": "Splash\\Core\\Models\\AbstractObject", "x-splash-type": "Product", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "sku": { "type": "string", "title": "Reference", "description": "Product reference (SKU)\n\n- **Template:** `Splash\\Templates\\Product\\Core\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `model`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "model", "x-technical-description": "Product internal reference or SKU (Stock Keeping Unit). Mapped to schema.org Product/model. This is the primary product identifier used in lists and search results. Required, indexed, listed and logged by default. Must be unique within the connector's product catalog." }, "name": { "type": "string", "title": "Product Name", "description": "Full product name\n\n- **Template:** `Splash\\Templates\\Product\\Core\\Name::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`\n- `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Product display name. Mapped to schema.org Product/name. Required and listed by default. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. name_fr_FR)." }, "alternateName": { "type": "string", "title": "Alternate Name", "description": "Product alternate or short name\n\n- **Template:** `Splash\\Templates\\Product\\Core\\AlternateName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `alternateName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "alternateName", "x-technical-description": "Product alternate or short name. Mapped to schema.org Product/alternateName. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. alternateName_fr_FR)." }, "weight": { "type": "number", "title": "Weight", "description": "Product weight\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Weight::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `weight`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "weight", "x-technical-description": "Product weight value. Mapped to schema.org Product/weight. Value is always in metric units (Kg)." }, "length": { "type": "number", "title": "Length", "description": "Product length\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Length::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `depth`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "depth", "x-technical-description": "Product length / depth value. Mapped to schema.org Product/depth. Value is always in metric units (m)." }, "width": { "type": "number", "title": "Width", "description": "Product width\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Width::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `width`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "width", "x-technical-description": "Product width value. Mapped to schema.org Product/width. Value is always in metric units (m)." }, "height": { "type": "number", "title": "Height", "description": "Product height\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Height::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `height`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "height", "x-technical-description": "Product height value. Mapped to schema.org Product/height. Value is always in metric units (m)." }, "surface": { "type": "number", "title": "Surface Area", "description": "Product surface area\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Surface::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `surface`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "surface", "x-technical-description": "Product surface area value. Mapped to schema.org Product/surface. Value is always in metric units (m2)." }, "volume": { "type": "number", "title": "Volume", "description": "Product volume\n\n- **Template:** `Splash\\Templates\\Product\\Dimensions\\Volume::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `volume`", "x-splash-type": "double", "format": "double", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "volume", "x-technical-description": "Product volume value. Mapped to schema.org Product/volume. Value is always in metric units (m3)." }, "ean13": { "type": "string", "title": "EAN 13", "description": "Product EAN barcode\n\n- **Template:** `Splash\\Templates\\Product\\Identifiers\\Ean13::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `gtin13`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "gtin13", "x-technical-description": "EAN-13 barcode (International Article Number). Mapped to schema.org Product/gtin13. 13-digit code." }, "upc": { "type": "string", "title": "UPC", "description": "Product UPC barcode\n\n- **Template:** `Splash\\Templates\\Product\\Identifiers\\Upc::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `gtin12`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "gtin12", "x-technical-description": "Universal Product Code (UPC-A). Mapped to schema.org Product/gtin12. 12-digit code. Mainly used in North America." }, "isbn": { "type": "string", "title": "ISBN", "description": "Product ISBN code\n\n- **Template:** `Splash\\Templates\\Product\\Identifiers\\Isbn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `gtin14`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "gtin14", "x-technical-description": "International Standard Book Number. Mapped to schema.org Product/gtin14. Used for books and publications." }, "mpn": { "type": "string", "title": "MPN", "description": "Manufacturer part number\n\n- **Template:** `Splash\\Templates\\Product\\Identifiers\\Mpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number. Mapped to schema.org Product/mpn. Used for cross-referencing with supplier catalogs." }, "barcode": { "type": "string", "title": "Barcode", "description": "Product barcode\n\n- **Template:** `Splash\\Templates\\Product\\Identifiers\\Barcode::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `qrcode`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "qrcode", "x-technical-description": "Generic barcode value. Mapped to schema.org Product/qrcode. Use EAN13 or UPC for standard barcodes when available." }, "offered": { "type": "boolean", "title": "Available for Sale", "description": "Product is available for sale\n\n- **Template:** `Splash\\Templates\\Product\\Flags\\Offered::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `offered`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "offered", "x-technical-description": "Boolean flag indicating if the product can be purchased. Mapped to schema.org Product/offered." }, "stockLevel": { "type": "integer", "title": "Stock Level", "description": "Current stock quantity\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\StockLevel::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `inventoryLevel`\n- `\ud83d\udccb In List`", "x-splash-type": "int", "format": "int", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "inventoryLevel", "x-technical-description": "Current stock level / quantity on hand. Mapped to schema.org Offer/inventoryLevel." }, "stockAlertLevel": { "type": "integer", "title": "Alert Level", "description": "Stock alert threshold\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\StockAlertLevel::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `inventoryAlertLevel`", "x-splash-type": "int", "format": "int", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "inventoryAlertLevel", "x-technical-description": "Minimum stock level before alert is triggered. Mapped to schema.org Offer/inventoryAlertLevel." }, "stockTargetLevel": { "type": "integer", "title": "Target Level", "description": "Desired stock level\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\StockTargetLevel::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `inventoryTargetLevel`", "x-splash-type": "int", "format": "int", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "inventoryTargetLevel", "x-technical-description": "Target or desired stock level for replenishment. Mapped to schema.org Offer/inventoryTargetLevel." }, "isDefault": { "type": "boolean", "title": "Is Default Variant", "description": "Indicates if this variant is the default one\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\IsDefault::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `isDefaultVariation`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "isDefaultVariation", "x-technical-description": "Boolean flag indicating the default variant of a product. Mapped to schema.org Product/isDefaultVariation. Read-only, set by the e-commerce platform." }, "baseProduct__sku": { "type": "string", "title": "Parent SKU", "description": "Parent product SKU of this variant\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\ParentSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `isVariationOfName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "isVariationOfName", "x-technical-description": "SKU/reference of the parent product this variant belongs to. Mapped to schema.org Product/isVariationOfName." }, "baseProduct__dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "baseProduct__dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "baseProduct__shortDescription": { "type": "string", "title": "Short Description", "description": "Product short description\n\n- **Template:** `Splash\\Templates\\Product\\Core\\ShortDescription::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `description`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "description", "x-technical-description": "Product short description. Splash type is 'varchar'. Mapped to schema.org Product/description. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. description_fr_FR)." }, "baseProduct__shortDescriptionUs": { "type": "string", "title": "Short Description", "description": "Product short description\n\n- **Template:** `Splash\\Templates\\Product\\Core\\ShortDescription::class`\n- **Microdata:** `http://schema.org/Product/en_US` \u2192 `description`\n- **Options:**\n - **language** => en_US", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product/en_US", "x-schema-org-itemprop": "description", "x-technical-description": "Product short description. Splash type is 'varchar'. Mapped to schema.org Product/description. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. description_fr_FR)." }, "baseProduct__longDescription": { "type": "string", "title": "Long Description", "description": "Product long or detailed description\n\n- **Template:** `Splash\\Templates\\Product\\Core\\LongDescription::class`\n- **Microdata:** `http://schema.org/Article` \u2192 `articleBody`\n- **Options:**\n - **language** => fr_FR\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http://schema.org/Article", "x-schema-org-itemprop": "articleBody", "x-technical-description": "Long or detailed product description, may contain HTML. Splash type is 'text' (long text). Mapped to schema.org Article/articleBody, the tag used by all connectors for the rich description of a product page. On multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Article/fr_FR)." }, "baseProduct__longDescriptionUs": { "type": "string", "title": "Long Description", "description": "Product long or detailed description\n\n- **Template:** `Splash\\Templates\\Product\\Core\\LongDescription::class`\n- **Microdata:** `http://schema.org/Article/en_Us` \u2192 `articleBody`\n- **Options:**\n - **language** => en_Us\n- `\ud83d\udcdc Logged`", "x-splash-type": "text", "format": "text", "x-schema-org-itemtype": "http://schema.org/Article/en_Us", "x-schema-org-itemprop": "articleBody", "x-technical-description": "Long or detailed product description, may contain HTML. Splash type is 'text' (long text). Mapped to schema.org Article/articleBody, the tag used by all connectors for the rich description of a product page. On multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Article/fr_FR)." }, "baseProduct__warehouse": { "type": "string", "title": "Warehouse", "description": "Default warehouse location\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\Warehouse::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `inventoryLocation`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "inventoryLocation", "x-technical-description": "Default warehouse or storage location. Mapped to schema.org Offer/inventoryLocation." }, "baseProduct__minQuantity": { "type": "integer", "title": "Minimum Quantity", "description": "Minimum purchase quantity\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\MinQuantity::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `eligibleTransactionVolume`", "x-splash-type": "int", "format": "int", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "eligibleTransactionVolume", "x-technical-description": "Minimum quantity for purchase. Mapped to schema.org Offer/eligibleTransactionVolume." }, "baseProduct__active": { "type": "boolean", "title": "Active", "description": "Product is active\n\n- **Template:** `Splash\\Templates\\Product\\Flags\\Active::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `active`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "active", "x-technical-description": "Boolean flag indicating if the product is active/enabled. Mapped to schema.org Product/active. An inactive product is not visible to customers." }, "baseProduct__onSale": { "type": "boolean", "title": "On Sale", "description": "Product is on sale\n\n- **Template:** `Splash\\Templates\\Product\\Flags\\OnSale::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `onsale`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "onsale", "x-technical-description": "Boolean flag indicating the product is on sale/promotion. Mapped to schema.org Product/onsale." }, "baseProduct__metaDescription": { "type": "string", "title": "Meta Description", "description": "SEO meta description\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\MetaDescription::class`\n- **Microdata:** `http://schema.org/Article` \u2192 `headline`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Article", "x-schema-org-itemprop": "headline", "x-technical-description": "HTML meta description for SEO. Mapped to schema.org Article/headline. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. headline_fr_FR)." }, "baseProduct__metaDescriptionUs": { "type": "string", "title": "Meta Description", "description": "SEO meta description\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\MetaDescription::class`\n- **Microdata:** `http://schema.org/Article/en_Us` \u2192 `headline`\n- **Options:**\n - **language** => en_Us", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Article/en_Us", "x-schema-org-itemprop": "headline", "x-technical-description": "HTML meta description for SEO. Mapped to schema.org Article/headline. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. headline_fr_FR)." }, "baseProduct__metaKeywords": { "type": "string", "title": "Meta Keywords", "description": "SEO meta keywords\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\MetaKeywords::class`\n- **Microdata:** `http://schema.org/Article` \u2192 `keywords`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Article", "x-schema-org-itemprop": "keywords", "x-technical-description": "Comma-separated list of product SEO tags. Mapped to schema.org Article/keywords. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. keywords_fr_FR)." }, "baseProduct__metaKeywordsUs": { "type": "string", "title": "Meta Keywords", "description": "SEO meta keywords\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\MetaKeywords::class`\n- **Microdata:** `http://schema.org/Article/en_Us` \u2192 `keywords`\n- **Options:**\n - **language** => en_Us", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Article/en_Us", "x-schema-org-itemprop": "keywords", "x-technical-description": "Comma-separated list of product SEO tags. Mapped to schema.org Article/keywords. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. keywords_fr_FR)." }, "baseProduct__urlRewrite": { "type": "string", "title": "Friendly URL", "description": "SEO-friendly URL slug\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\UrlRewrite::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `urlRewrite`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "urlRewrite", "x-technical-description": "URL-friendly slug for the product page. Mapped to schema.org Product/urlRewrite, the tag used by all connectors. Must be URL-safe (lowercase, hyphens, no spaces)." }, "baseProduct__urlRewriteUs": { "type": "string", "title": "Friendly URL", "description": "SEO-friendly URL slug\n\n- **Template:** `Splash\\Templates\\Product\\Seo\\UrlRewrite::class`\n- **Microdata:** `http://schema.org/Product/en_Us` \u2192 `urlRewrite`\n- **Options:**\n - **language** => en_Us", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Product/en_Us", "x-schema-org-itemprop": "urlRewrite", "x-technical-description": "URL-friendly slug for the product page. Mapped to schema.org Product/urlRewrite, the tag used by all connectors. Must be URL-safe (lowercase, hyphens, no spaces)." }, "baseProduct__basePrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Base Price", "description": "Product base price (excl. tax)\n\n- **Template:** `Splash\\Templates\\Product\\Pricing\\BasePrice::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `basePrice`", "x-splash-type": "price", "format": "price", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "basePrice", "x-technical-description": "Product base price before tax. Splash type is 'price'. Mapped to schema.org Product/basePrice.", "example": { "base": 0, "ht": 175.91, "vat": 20, "tax": 35.18, "ttc": 211.09, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "nameWithOptions": { "type": "string", "title": "Name with Options", "description": "Product name with variant options\n\n- **Template:** `Splash\\Templates\\Product\\Core\\NameWithOptions::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `variantName`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "variantName", "x-technical-description": "Product name including variant attributes (e.g. 'T-Shirt - Red - XL'). Identical to Name on simple products. Mapped to schema.org Product/variantName. On multilingual connectors, non-default language fields use a suffixed MICRODATA_PROP (e.g. variantName_fr_FR)." }, "price": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Price", "description": "Product selling price\n\n- **Template:** `Splash\\Templates\\Product\\Pricing\\Price::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `price`\n- `\ud83d\udccb In List`", "x-splash-type": "price", "format": "price", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "price", "x-technical-description": "Product selling price. Splash type is 'price', a structured field containing amount, currency, VAT rate and HT/TTC flag. Mapped to schema.org Product/price. This is the main product price, available on all connectors. Listed by default.", "example": { "base": 0, "ht": 22.12, "vat": 20, "tax": 4.42, "ttc": 26.54, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "wholesalePrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Wholesale Price", "description": "Product wholesale / cost price\n\n- **Template:** `Splash\\Templates\\Product\\Pricing\\WholesalePrice::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `wholesalePrice`", "x-splash-type": "price", "format": "price", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "wholesalePrice", "x-technical-description": "Product wholesale or cost price. Splash type is 'price'. Mapped to schema.org Product/wholesalePrice. Used for margin calculation.", "example": { "base": 0, "ht": 175.6, "vat": 20, "tax": 35.12, "ttc": 210.72, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } }, "stockAlertFlag": { "type": "boolean", "title": "Stock Alert", "description": "Stock is below alert level\n\n- **Template:** `Splash\\Templates\\Product\\Stock\\StockAlertFlag::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `inventoryAlertFlag`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "inventoryAlertFlag", "x-technical-description": "Boolean flag indicating stock is below the alert threshold. Mapped to schema.org Offer/inventoryAlertFlag. Read-only on most connectors." }, "defaultVariant": { "type": "string", "format": "objectid::Product", "title": "Default Variant", "description": "Default variant product identifier\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\DefaultVariant::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `DefaultVariation`", "x-splash-type": "objectid::Product", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "DefaultVariation", "x-technical-description": "Object ID of the default variant product. Mapped to schema.org Product/DefaultVariation. Type is objectid::Product.", "example": "554::Product" }, "parentProduct": { "type": "string", "title": "Parent Product", "description": "Parent product identifier of this variant\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\ParentProduct::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `isVariationOf`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "isVariationOf", "x-technical-description": "Reference to the parent product this variant belongs to. Mapped to schema.org Product/isVariationOf. Read-only, set by the e-commerce platform." }, "cover_image": { "type": "string", "title": "Image de couverture", "description": "Photo principale du produit\n\n- **Template:** `Splash\\Templates\\Product\\Images\\CoverImage::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `coverImage`", "x-splash-type": "image", "format": "image", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "coverImage", "x-technical-description": "Product main picture, as a single Splash image outside of the gallery list. Read-only field, derived from the gallery: image flagged as cover for the current variant. Mapped to schema.org Product/coverImage. To change the cover, write the gallery isCover flags instead." }, "cover_image_url": { "type": "string", "format": "url", "title": "Url de l'image de couverture", "description": "Url publique de la photo principale du produit\n\n- **Template:** `Splash\\Templates\\Product\\Images\\CoverImageUrl::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `coverImageUrl`", "x-splash-type": "url", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "coverImageUrl", "x-technical-description": "Direct public url of the product cover image, used to fetch the main picture without downloading it through Splash. Read-only field, derived from the gallery: image flagged as cover for the current variant. Mapped to schema.org Product/coverImageUrl." }, "attributes": { "type": "array", "title": "Attributes", "x-splash-list": "attributes", "items": { "type": "object", "properties": { "code": { "type": "string", "title": "Code attribut", "description": "Code technique de l'attribut de variante\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\AttributeCode::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `VariantAttributeCode`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "VariantAttributeCode", "x-technical-description": "Technical code of the variant attribute (e.g. 'color', 'size'). Mapped to schema.org Product/VariantAttributeCode. This field must be added to a Combinations list. Base type is varchar, final type is varchar@list. Not multilingual." }, "name": { "type": "string", "title": "Nom d'attribut", "description": "Nom public de l'attribut de variante\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\AttributeName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `VariantAttributeName`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "VariantAttributeName", "x-technical-description": "Public name of the variant attribute (e.g. 'Color', 'Size'). Mapped to schema.org Product/VariantAttributeName. This field must be added to a Combinations list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Product/en_US)." }, "name_en_US": { "type": "string", "title": "Nom d'attribut", "description": "Nom public de l'attribut de variante\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\AttributeName::class`\n- **Microdata:** `http://schema.org/Product/en_US` \u2192 `VariantAttributeName`\n- **Options:**\n - **language** => en_US", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product/en_US", "x-schema-org-itemprop": "VariantAttributeName", "x-technical-description": "Public name of the variant attribute (e.g. 'Color', 'Size'). Mapped to schema.org Product/VariantAttributeName. This field must be added to a Combinations list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Product/en_US)." }, "value": { "type": "string", "title": "Valeur d'attribut", "description": "Valeur de l'attribut de variante\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\AttributeValue::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `VariantAttributeValue`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "VariantAttributeValue", "x-technical-description": "Value of the variant attribute (e.g. 'Red', 'XL'). Mapped to schema.org Product/VariantAttributeValue. This field must be added to a Combinations list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Product/en_US)." }, "value_en_US": { "type": "string", "title": "Valeur d'attribut", "description": "Valeur de l'attribut de variante\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\AttributeValue::class`\n- **Microdata:** `http://schema.org/Product/en_US` \u2192 `VariantAttributeValue`\n- **Options:**\n - **language** => en_US", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product/en_US", "x-schema-org-itemprop": "VariantAttributeValue", "x-technical-description": "Value of the variant attribute (e.g. 'Red', 'XL'). Mapped to schema.org Product/VariantAttributeValue. This field must be added to a Combinations list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed MICRODATA_URL (e.g. Product/en_US)." } } } }, "images": { "type": "array", "title": "Images", "x-splash-list": "images", "items": { "type": "object", "properties": { "image": { "type": "string", "title": "Image", "description": "Image de la galerie du produit\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\Image::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `image`", "x-splash-type": "image@list", "format": "image@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "image", "x-technical-description": "Product gallery image, transported as a Splash image (name, filename, md5, size, path or file, width, height). The gallery holds all photos of all variants of the product. Mapped to schema.org Product/image. This field must be added to an Images list. Base type is image, final type is image@list. Three companion fields are required to build a gallery: the image position (Product/positionImage), the cover flag (Product/isCover) and the visible flag (Product/isVisibleImage)." }, "position": { "type": "integer", "title": "Position", "description": "Position de l'image dans la galerie\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\Position::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `positionImage`\n- `\ud83e\uddea No Tests`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "positionImage", "x-technical-description": "Position of the image inside the product gallery. Usually a following sequence (0, 1, 2, 3...) but may depend on the product variants. Mapped to schema.org Product/positionImage. This field must be added to an Images list. Base type is int, final type is int@list." }, "cover": { "type": "boolean", "title": "Couverture", "description": "Cette image est la photo de couverture du produit\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\IsCover::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `isCover`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool@list", "format": "bool@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "isCover", "x-technical-description": "Flag set on the image used as the product cover picture: the main picture displayed by websites for the product. On variable products, the flag is carried by the gallery of each variant to designate the product cover to display when it is selected. Mapped to schema.org Product/isCover. This field must be added to an Images list. Base type is bool, final type is bool@list." }, "visible": { "type": "boolean", "title": "Visible", "description": "Cette image est visible pour la variante en cours\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\IsVisible::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `isVisibleImage`\n- `\ud83e\uddea No Tests`", "x-splash-type": "bool@list", "format": "bool@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "isVisibleImage", "x-technical-description": "Flag set when this image is visible for the current variant. On simple products all images are usually visible, on variable products each variant flags its own visible images. Mapped to schema.org Product/isVisibleImage. This field must be added to an Images list. Base type is bool, final type is bool@list." }, "legend": { "type": "string", "title": "L\u00e9gende", "description": "L\u00e9gende ou titre m\u00e9ta de l'image\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\Legend::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `imageName`\n- **Options:**\n - **language** => fr_FR", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "imageName", "x-technical-description": "Image legend, used as meta title or description of the picture. Mapped to schema.org Product/imageName. This field must be added to an Images list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed identifier (e.g. legend_en_US)." }, "legend_en_US": { "type": "string", "title": "L\u00e9gende", "description": "L\u00e9gende ou titre m\u00e9ta de l'image\n\n- **Template:** `Splash\\Templates\\Product\\Gallery\\Legend::class`\n- **Microdata:** `http://schema.org/Product/en_US` \u2192 `imageName`\n- **Options:**\n - **language** => en_US", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product/en_US", "x-schema-org-itemprop": "imageName", "x-technical-description": "Image legend, used as meta title or description of the picture. Mapped to schema.org Product/imageName. This field must be added to an Images list. Base type is varchar, final type is varchar@list. Multilingual: on multilingual connectors, non-default language fields use a suffixed identifier (e.g. legend_en_US)." } } } }, "variants": { "type": "array", "title": "Variants", "x-splash-list": "variants", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "objectid::Product@list", "title": "ID Variante", "description": "Liste des identifiants des variantes du produit\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\VariantList::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `Variants`\n- `\ud83e\uddea No Tests`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "Variants", "x-technical-description": "List of variant product IDs belonging to the same parent. Mapped to schema.org Product/Variants. Type is objectid::Product@list.", "example": "294::Product" }, "sku": { "type": "string", "title": "SKU Variante", "description": "Liste des references des variantes du produit\n\n- **Template:** `Splash\\Templates\\Product\\Variants\\VariantSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `VariationName`\n- `\ud83e\uddea No Tests`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "VariationName", "x-technical-description": "List of variant product SKUs belonging to the same parent. Mapped to schema.org Product/VariationName. Read-only, type is varchar@list." } } } } }, "required": [ "sku", "name" ] }, "ProductListItem": { "type": "object", "title": "Product (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "sku": { "type": "string", "title": "Reference" }, "name": { "type": "string", "title": "Product Name" }, "stockLevel": { "type": "integer", "title": "Stock Level" }, "price": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Price" } } }, "Quotation": { "type": "object", "title": "Quotation", "description": "Sample Quotation Object: commercial offer sent to a customer,\nsharing the generic accounting fields of the Order object.\n\n#### Lifecycle\n\nThe normalized `status` is the single source of truth; `isDraft`,\n`isValidated`, `isSigned`, `isRefused` and `isCanceled` are **read-only\nprojections** of it, exposed so connectors can filter without decoding\nthe status code.\n\n#### Validity\n\n`validityDate` closes the offer: prices and availability are no longer\nguaranteed afterwards, and the quotation usually moves to an expired status.\n ", "x-splash-type": "Quotation", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "currency": { "type": "string", "format": "currency", "title": "Currency", "description": "Currency of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\Currency::class`\n- **Microdata:** `https://schema.org/PriceSpecification` \u2192 `priceCurrency`", "x-splash-type": "currency", "x-schema-org-itemtype": "https://schema.org/PriceSpecification", "x-schema-org-itemprop": "priceCurrency", "x-technical-description": "Currency of ALL amounts of the document: totals, line unit prices and payments are expressed in it, no amount carries its own currency. Splash type is 'currency', an ISO 4217 code (EUR, USD, GBP...). Usually read-only, the currency being chosen when the document is created and never changed afterwards. Mapped to schema.org PriceSpecification/priceCurrency (https scheme: new field, no legacy pairing to preserve)." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer of the document (order / invoice)\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this accounting document to its customer ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID, on every accounting document. When reading, the connector must return the Splash-encoded ID of the customer ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference. MIGRATION: legacy connectors tag this field as Organization/ID on orders but as Invoice/customer on invoices, credit notes & quotations. This is the very same data, so this template unifies them: on invoicing documents, replace the legacy Invoice/customer metadata by this one.", "example": "663::ThirdParty" }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "542::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "540::Address" }, "date": { "type": "string", "format": "date", "title": "Order Date", "description": "Date the order was placed\n\n- **Template:** `Splash\\Templates\\Order\\Core\\Date::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDate", "x-technical-description": "Date the order was placed. Format: Splash date (Y-m-d). Mapped to schema.org Order/orderDate. Required and listed by default.", "example": "2026-09-10" }, "validityDate": { "type": "string", "format": "date", "title": "Validity End Date", "description": "Date until the quotation stays valid\n\n- **Template:** `Splash\\Templates\\Quotation\\Core\\ValidityDate::class`\n- **Microdata:** `http://schema.org/Offer` \u2192 `availabilityEnds`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Offer", "x-schema-org-itemprop": "availabilityEnds", "x-technical-description": "Date until the quotation offer stays valid: prices and availability are no longer guaranteed afterwards, and the quotation is usually moved to an expired status. Format: Splash date (Y-m-d). Mapped to schema.org Offer/availabilityEnds.", "example": "2026-09-10" }, "deliveryDate": { "type": "string", "format": "date", "title": "Delivery Date", "description": "Expected delivery date to the customer\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\DeliveryDate::class`\n- **Microdata:** `http://schema.org/ParcelDelivery` \u2192 `expectedArrivalUntil`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/ParcelDelivery", "x-schema-org-itemprop": "expectedArrivalUntil", "x-technical-description": "Date the goods are expected to be delivered to the customer. Set on sale documents (orders, quotations) by the selling application. Format: Splash date (Y-m-d). Mapped to schema.org ParcelDelivery/expectedArrivalUntil.", "example": "2026-09-10" }, "refInternal": { "type": "string", "title": "Internal Ref.", "description": "Unique internal order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefInternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `name`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "name", "x-technical-description": "Internal unique reference of the order, generated by the remote application (e.g. 'CMD2024-0001'). Mapped to schema.org Order/name. Read-only by convention. Indexed and listed by default." }, "refCustomer": { "type": "string", "title": "Customer Ref.", "description": "Customer-side order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefCustomer::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderNumber`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderNumber", "x-technical-description": "Reference of the order on the customer side (e.g. a PO number). Mapped to schema.org Order/orderNumber. Indexed and listed by default." }, "refExternal": { "type": "string", "title": "External Ref.", "description": "External order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefExternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `alternateName`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "alternateName", "x-technical-description": "External reference of the order, typically coming from a third-party system (e.g. a marketplace order ID). Mapped to schema.org Order/alternateName. Indexed by default." }, "status": { "type": "string", "title": "Quotation Status", "description": "Normalized status of the quotation\n\n- **Template:** `Splash\\Templates\\Quotation\\Status\\Status::class`\n- **Microdata:** `http://schema.org/Quote` \u2192 `status`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Quote", "x-schema-org-itemprop": "status", "enum": [ "QuoteDraft", "QuoteValidated", "QuoteSend", "QuoteApprouved", "QuoteRefused", "QuoteOrdered", "QuoteExpired", "QuoteCanceled" ], "x-technical-description": "Current status of the quotation. Mapped to schema.org Quote/status. Allowed values come from the Splash\\Core\\Dictionary\\Objects\\Quotation\\Status dictionary (CANCELED, DRAFT, VALIDATED, SEND, APPROUVED, ORDERED, REFUSED, EXPIRED). Connectors expose only the subset of statuses they support via SPL\\Choices." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "isDraft": { "type": "boolean", "title": "Order : Draft", "description": "The order is in draft state\n\n- **Template:** `Splash\\Templates\\Order\\Status\\IsDraft::class`\n- **Microdata:** `http://schema.org/OrderStatus` \u2192 `OrderDraft`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderStatus", "x-schema-org-itemprop": "OrderDraft", "x-technical-description": "Boolean flag indicating that the order is in draft state. Mapped to schema.org OrderStatus/OrderDraft. Read-only, derived from the order status. Mutually exclusive with isCanceled / isValidated / isClosed." }, "isValidated": { "type": "boolean", "title": "Order : Validated", "description": "The order has been validated\n\n- **Template:** `Splash\\Templates\\Order\\Status\\IsValidated::class`\n- **Microdata:** `http://schema.org/OrderStatus` \u2192 `OrderProcessing`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderStatus", "x-schema-org-itemprop": "OrderProcessing", "x-technical-description": "Boolean flag indicating that the order has been validated and is being processed. Mapped to schema.org OrderStatus/OrderProcessing. Read-only, derived from the order status. Mutually exclusive with isDraft / isCanceled / isClosed." }, "isSigned": { "type": "boolean", "title": "Is Signed", "description": "The quotation was signed by the customer\n\n- **Template:** `Splash\\Templates\\Quotation\\Status\\IsSigned::class`\n- **Microdata:** `https://schema.org/QuoteStatus` \u2192 `QuoteApprouved`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/QuoteStatus", "x-schema-org-itemprop": "QuoteApprouved", "x-technical-description": "Quotation was accepted & signed by the customer. Read-only flag derived from the quotation status, exposed so that connectors can filter without decoding the status code: true when the status equals Splash\\Core\\Dictionary\\Objects\\Quotation\\Status::APPROUVED. Mapped to schema.org QuoteStatus/QuoteApprouved (https scheme: new field, no legacy pairing to preserve). Grouped under 'Status' by convention." }, "isRefused": { "type": "boolean", "title": "Is Refused", "description": "The quotation was refused by the customer\n\n- **Template:** `Splash\\Templates\\Quotation\\Status\\IsRefused::class`\n- **Microdata:** `https://schema.org/QuoteStatus` \u2192 `QuoteRefused`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/QuoteStatus", "x-schema-org-itemprop": "QuoteRefused", "x-technical-description": "Quotation was refused by the customer and will not be converted. Read-only flag derived from the quotation status, exposed so that connectors can filter without decoding the status code: true when the status equals Splash\\Core\\Dictionary\\Objects\\Quotation\\Status::REFUSED. Mapped to schema.org QuoteStatus/QuoteRefused (https scheme: new field, no legacy pairing to preserve). Grouped under 'Status' by convention." }, "isCanceled": { "type": "boolean", "title": "Order : Canceled", "description": "The order has been canceled\n\n- **Template:** `Splash\\Templates\\Order\\Status\\IsCanceled::class`\n- **Microdata:** `http://schema.org/OrderStatus` \u2192 `OrderCancelled`", "x-splash-type": "bool", "format": "bool", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderStatus", "x-schema-org-itemprop": "OrderCancelled", "x-technical-description": "Boolean flag indicating that the order has been canceled. Mapped to schema.org OrderStatus/OrderCancelled. Read-only, derived from the order status. Mutually exclusive with isDraft / isValidated / isClosed." }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Line Type", "description": "Normalized type of the line\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Type::class`\n- **Microdata:** `https://schema.org/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "https://schema.org/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ], "x-technical-description": "Qualifies WHAT the accounting line is, so that the receiving application does not have to guess it from the line label. Accepted values are Splash normalized codes from the AccountLineType dictionary: 'product' (sold product or service), 'shipping' (delivery charges), 'fee' (extra charge or global discount), 'option' (optional line, qty = 0 & price != 0), 'comment' (free text, qty = 1 & price = 0). An EMPTY value means a regular product line, so connectors that ignore this field keep working as before. Mapped to schema.org OrderItem/additionalType (https scheme: new field, no legacy pairing to preserve). Final type is varchar@list." }, "description": { "type": "string", "title": "Description", "description": "Line description\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Description::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "description", "x-technical-description": "Free-text description of the accounting line item (typically the product short description). Mapped to schema.org partOfInvoice/description. Final type is varchar@list." }, "productSku": { "type": "string", "title": "Product SKU", "description": "SKU of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product attached to the accounting line. Mapped to schema.org Product/sku. Final type is varchar@list." }, "productName": { "type": "string", "title": "Product Name", "description": "Name of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Name of the product attached to the accounting line (typically a snapshot of the product name at the time of sale). Mapped to schema.org Product/name. Final type is varchar@list." }, "productMpn": { "type": "string", "title": "Supplier Ref.", "description": "Supplier reference (MPN) of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductMpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number (MPN) of the product attached to the accounting line. Mapped to schema.org Product/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Quantity", "description": "Line quantity\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Quantity::class`\n- **Microdata:** `http://schema.org/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/QuantitativeValue", "x-schema-org-itemprop": "value", "x-technical-description": "Quantity of the accounting line item. Mapped to schema.org QuantitativeValue/value. Final type is int@list." }, "discount": { "type": "number", "title": "Discount (%)", "description": "Discount applied to the line, in percent\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Discount::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "discount", "x-technical-description": "Percentage discount applied to the accounting line item. Mapped to schema.org Order/discount. Final type is double@list." }, "vatCode": { "type": "string", "title": "VAT Code", "description": "Code or name of the applicable VAT rate\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\VatCode::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName", "x-technical-description": "Code or name of the VAT rate applied to the accounting line item (e.g. '20.0', 'TVA20', 'std'). Mapped to schema.org PriceSpecification/valueAddedTaxName. Final type is varchar@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product ID", "description": "Splash ID of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductId::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash Object ID referencing the Product attached to the accounting line. Mapped to schema.org Product/productID. Final type is objectid::Product@list.", "example": "6::Product" }, "options": { "type": "string", "title": "Options", "description": "Line details (options, attributes, ...)\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Options::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "options", "x-technical-description": "Line item options as an inline list of strings, one entry per visible option, formatted as 'key: value' (product variation attributes, personalization, add-ons, ...). Typically extracted from order line meta data by the connector. This field is read-only: options are informative and never written back. Mapped to schema.org partOfInvoice/options. Final type is inline@list." }, "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Unit Price", "description": "Line unit price\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\UnitPrice::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Unit price of the accounting line item, expressed as a Splash price block (amount, VAT, currency, etc.). Mapped to schema.org PriceSpecification/price. Final type is price@list.", "example": { "base": 0, "ht": 92.74, "vat": 20, "tax": 18.55, "ttc": 111.29, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } } } } } }, "required": [ "date", "refCustomer" ] }, "QuotationListItem": { "type": "object", "title": "Quotation (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "date": { "type": "string", "format": "date", "title": "Order Date" }, "refInternal": { "type": "string", "title": "Internal Ref." }, "refCustomer": { "type": "string", "title": "Customer Ref." } } }, "SupplierInvoice": { "type": "object", "title": "SupplierInvoice", "description": "Sample Supplier Invoice Object: purchase counterpart of the\nInvoice object, built from the very same field templates.\n\n#### Purchase vs Sale\n\nThe ThirdParty link points to the **supplier**, and references are reversed:\n`refInternal` is our own booking reference, `refCustomer` is the invoice\nnumber issued by the supplier.\n\n#### Payments\n\nSettlements are exposed as a **list**: an invoice may be paid by several\npayments, each one carrying its method code, date, transaction id & amount.\n ", "x-splash-type": "SupplierInvoice", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "currency": { "type": "string", "format": "currency", "title": "Currency", "description": "Currency of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\Currency::class`\n- **Microdata:** `https://schema.org/PriceSpecification` \u2192 `priceCurrency`", "x-splash-type": "currency", "x-schema-org-itemtype": "https://schema.org/PriceSpecification", "x-schema-org-itemprop": "priceCurrency", "x-technical-description": "Currency of ALL amounts of the document: totals, line unit prices and payments are expressed in it, no amount carries its own currency. Splash type is 'currency', an ISO 4217 code (EUR, USD, GBP...). Usually read-only, the currency being chosen when the document is created and never changed afterwards. Mapped to schema.org PriceSpecification/priceCurrency (https scheme: new field, no legacy pairing to preserve)." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer of the document (order / invoice)\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this accounting document to its customer ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID, on every accounting document. When reading, the connector must return the Splash-encoded ID of the customer ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference. MIGRATION: legacy connectors tag this field as Organization/ID on orders but as Invoice/customer on invoices, credit notes & quotations. This is the very same data, so this template unifies them: on invoicing documents, replace the legacy Invoice/customer metadata by this one.", "example": "384::ThirdParty" }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "448::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "739::Address" }, "date": { "type": "string", "format": "date", "title": "Invoice Date", "description": "Official issuing date of the invoice\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\Date::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDate", "x-technical-description": "Official issuing date of the invoice, the one printed on the document and used for accounting periods. Not the date the related order was placed. Format: Splash date (Y-m-d). Mapped to schema.org Order/orderDate \u2014 same microdata as the Order Date template, so both documents pair on their own date. Required and listed by default.", "example": "2026-09-10" }, "paymentDueDate": { "type": "string", "format": "date", "title": "Payment Due Date", "description": "Date the payment is expected\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\PaymentDueDate::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `paymentDueDate`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "paymentDueDate", "x-technical-description": "Date the payment of the invoice is due, computed by the accounting application from the invoice date and the payment term of the customer. Used to detect overdue invoices. Format: Splash date (Y-m-d). Mapped to schema.org Invoice/paymentDueDate.", "example": "2026-09-10" }, "refInternal": { "type": "string", "title": "Internal Ref.", "description": "Unique internal invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefInternal::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `name`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "name", "x-technical-description": "Internal unique reference of the invoice, generated by the remote application (e.g. 'FA2024-0001'). Mapped to schema.org Invoice/name. Read-only by convention. Indexed and listed by default." }, "refCustomer": { "type": "string", "title": "Customer Ref.", "description": "Customer-side invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefCustomer::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `confirmationNumber`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "confirmationNumber", "x-technical-description": "Reference of the invoice on the customer side (e.g. a confirmation number). Mapped to schema.org Invoice/confirmationNumber. Indexed and listed by default." }, "refExternal": { "type": "string", "title": "External Ref.", "description": "External invoice reference\n\n- **Template:** `Splash\\Templates\\Invoice\\Core\\RefExternal::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `alternateName`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "alternateName", "x-technical-description": "External reference of the invoice, typically coming from a third-party system. Mapped to schema.org Invoice/alternateName. Indexed and listed by default." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Line Type", "description": "Normalized type of the line\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Type::class`\n- **Microdata:** `https://schema.org/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "https://schema.org/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ], "x-technical-description": "Qualifies WHAT the accounting line is, so that the receiving application does not have to guess it from the line label. Accepted values are Splash normalized codes from the AccountLineType dictionary: 'product' (sold product or service), 'shipping' (delivery charges), 'fee' (extra charge or global discount), 'option' (optional line, qty = 0 & price != 0), 'comment' (free text, qty = 1 & price = 0). An EMPTY value means a regular product line, so connectors that ignore this field keep working as before. Mapped to schema.org OrderItem/additionalType (https scheme: new field, no legacy pairing to preserve). Final type is varchar@list." }, "description": { "type": "string", "title": "Description", "description": "Line description\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Description::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "description", "x-technical-description": "Free-text description of the accounting line item (typically the product short description). Mapped to schema.org partOfInvoice/description. Final type is varchar@list." }, "productSku": { "type": "string", "title": "Product SKU", "description": "SKU of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product attached to the accounting line. Mapped to schema.org Product/sku. Final type is varchar@list." }, "productName": { "type": "string", "title": "Product Name", "description": "Name of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Name of the product attached to the accounting line (typically a snapshot of the product name at the time of sale). Mapped to schema.org Product/name. Final type is varchar@list." }, "productMpn": { "type": "string", "title": "Supplier Ref.", "description": "Supplier reference (MPN) of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductMpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number (MPN) of the product attached to the accounting line. Mapped to schema.org Product/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Quantity", "description": "Line quantity\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Quantity::class`\n- **Microdata:** `http://schema.org/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/QuantitativeValue", "x-schema-org-itemprop": "value", "x-technical-description": "Quantity of the accounting line item. Mapped to schema.org QuantitativeValue/value. Final type is int@list." }, "discount": { "type": "number", "title": "Discount (%)", "description": "Discount applied to the line, in percent\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Discount::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "discount", "x-technical-description": "Percentage discount applied to the accounting line item. Mapped to schema.org Order/discount. Final type is double@list." }, "vatCode": { "type": "string", "title": "VAT Code", "description": "Code or name of the applicable VAT rate\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\VatCode::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName", "x-technical-description": "Code or name of the VAT rate applied to the accounting line item (e.g. '20.0', 'TVA20', 'std'). Mapped to schema.org PriceSpecification/valueAddedTaxName. Final type is varchar@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product ID", "description": "Splash ID of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductId::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash Object ID referencing the Product attached to the accounting line. Mapped to schema.org Product/productID. Final type is objectid::Product@list.", "example": "338::Product" }, "options": { "type": "string", "title": "Options", "description": "Line details (options, attributes, ...)\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Options::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "options", "x-technical-description": "Line item options as an inline list of strings, one entry per visible option, formatted as 'key: value' (product variation attributes, personalization, add-ons, ...). Typically extracted from order line meta data by the connector. This field is read-only: options are informative and never written back. Mapped to schema.org partOfInvoice/options. Final type is inline@list." }, "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Unit Price", "description": "Line unit price\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\UnitPrice::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Unit price of the accounting line item, expressed as a Splash price block (amount, VAT, currency, etc.). Mapped to schema.org PriceSpecification/price. Final type is price@list.", "example": { "base": 0, "ht": 57.87, "vat": 20, "tax": 11.57, "ttc": 69.44, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } } } } }, "payments": { "type": "array", "title": "Payments", "x-splash-list": "payments", "items": { "type": "object", "properties": { "mode": { "type": "string", "title": "Payment Method", "description": "Method of the payment\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentMode::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `PaymentMethod`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "PaymentMethod", "enum": [ "ByBankTransferInAdvance", "CheckInAdvance", "Cash", "CreditCard", "PayPal" ], "x-technical-description": "Method used to settle this payment. Always a CODE, never a human readable label. Recommended values are the Splash normalized codes of the PaymentMethods dictionary (GoodRelations vocabulary: 'ByBankTransferInAdvance', 'CheckInAdvance', 'Cash', 'COD', 'ByInvoice', 'DirectDebit', 'CreditCard', 'PayPal'...), but any application specific code is accepted, depending on the customer configuration. Allowed values are exposed via SPL\\Choices. Mapped to schema.org Invoice/PaymentMethod (capital P: historical Splash mapping shared by ALL existing connectors). List field: a document may be settled by several payments: the group is carried by the list itself." }, "date": { "type": "string", "format": "date@list", "title": "Date", "description": "Date the payment was received\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentDate::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `validFrom`", "x-splash-type": "date@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "validFrom", "x-technical-description": "Date the payment was received / cashed. Splash type is a LIST of 'date', formatted as YYYY-MM-DD. Mapped to schema.org PaymentChargeSpecification/validFrom. Usually read-only, the date being set by the accounting application when the payment is registered. List field: a document may be settled by several payments: the group is carried by the list itself.", "example": "2026-09-10" }, "number": { "type": "string", "title": "Transaction ID", "description": "Reference of the payment transaction\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentNumber::class`\n- **Microdata:** `http://schema.org/Invoice` \u2192 `paymentMethodId`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Invoice", "x-schema-org-itemprop": "paymentMethodId", "x-technical-description": "Reference identifying the payment transaction: bank transaction id, check number, payment gateway reference... Mapped to schema.org Invoice/paymentMethodId \u2014 historical Splash mapping shared by ALL existing connectors, kept as-is even though the itemprop name suggests a method rather than a transaction. Same itemprop as the document level PaymentMethod template (Misc), without ambiguity: this one is a list field. List field: a document may be settled by several payments: the group is carried by the list itself." }, "amount": { "type": "number", "title": "Amount", "description": "Received amount, taxes included\n\n- **Template:** `Splash\\Templates\\Accounting\\Payments\\PaymentAmount::class`\n- **Microdata:** `http://schema.org/PaymentChargeSpecification` \u2192 `price`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/PaymentChargeSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Amount of this payment, taxes included, in the document currency. Splash type is a LIST of 'double': raw amounts without currency, unlike 'price' fields. Mapped to schema.org PaymentChargeSpecification/price. The sum of all payments of a document is compared to its total to compute the paid / due status. List field: a document may be settled by several payments: the group is carried by the list itself." } } } } }, "required": [ "date", "refCustomer" ] }, "SupplierInvoiceListItem": { "type": "object", "title": "SupplierInvoice (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "date": { "type": "string", "format": "date", "title": "Invoice Date" }, "refInternal": { "type": "string", "title": "Internal Ref." }, "refCustomer": { "type": "string", "title": "Customer Ref." }, "refExternal": { "type": "string", "title": "External Ref." } } }, "SupplierOrder": { "type": "object", "title": "SupplierOrder", "description": "Sample Supplier Order Object: purchase counterpart of the\nOrder object, sharing the very same generic accounting fields.\n\n#### Purchase vs Sale\n\nThe ThirdParty link points to the **supplier**, and references are reversed:\n`refInternal` is our own purchase order reference, `refCustomer` is the\nreference of this order on the supplier side.\n\n#### Receptions\n\nGoods receiving is exposed as a **list** of `receptions@*`, parallel to the\nitems list: one entry per product, comparing the ordered quantity with the\nquantity actually received. Read-only, the warehouse application owns it.\n ", "x-splash-type": "SupplierOrder", "properties": { "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "currency": { "type": "string", "format": "currency", "title": "Currency", "description": "Currency of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\Currency::class`\n- **Microdata:** `https://schema.org/PriceSpecification` \u2192 `priceCurrency`", "x-splash-type": "currency", "x-schema-org-itemtype": "https://schema.org/PriceSpecification", "x-schema-org-itemprop": "priceCurrency", "x-technical-description": "Currency of ALL amounts of the document: totals, line unit prices and payments are expressed in it, no amount carries its own currency. Splash type is 'currency', an ISO 4217 code (EUR, USD, GBP...). Usually read-only, the currency being chosen when the document is created and never changed afterwards. Mapped to schema.org PriceSpecification/priceCurrency (https scheme: new field, no legacy pairing to preserve)." }, "thirdPartyId": { "type": "string", "format": "objectid::ThirdParty", "title": "Customer", "description": "Customer of the document (order / invoice)\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ThirdParty::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `ID`", "x-splash-type": "objectid::ThirdParty", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "ID", "x-technical-description": "Splash object ID linking this accounting document to its customer ThirdParty. Type is objectid::ThirdParty, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('ThirdParty', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Organization/ID, on every accounting document. When reading, the connector must return the Splash-encoded ID of the customer ThirdParty. When writing, the connector receives a Splash-encoded ID and must resolve it to a local entity reference. MIGRATION: legacy connectors tag this field as Organization/ID on orders but as Invoice/customer on invoices, credit notes & quotations. This is the very same data, so this template unifies them: on invoicing documents, replace the legacy Invoice/customer metadata by this one.", "example": "5::ThirdParty" }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "739::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "534::Address" }, "date": { "type": "string", "format": "date", "title": "Order Date", "description": "Date the order was placed\n\n- **Template:** `Splash\\Templates\\Order\\Core\\Date::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDate`\n- `\ud83d\udccb In List`", "x-splash-type": "date", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDate", "x-technical-description": "Date the order was placed. Format: Splash date (Y-m-d). Mapped to schema.org Order/orderDate. Required and listed by default.", "example": "2026-09-10" }, "arrivalDate": { "type": "string", "format": "date", "title": "Arrival Date", "description": "Expected arrival date of the goods\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ArrivalDate::class`\n- **Microdata:** `https://schema.org/ParcelDelivery` \u2192 `expectedArrivalFrom`", "x-splash-type": "date", "x-schema-org-itemtype": "https://schema.org/ParcelDelivery", "x-schema-org-itemprop": "expectedArrivalFrom", "x-technical-description": "Date the goods are expected to arrive from the supplier. Set on purchase documents (supplier orders) by the buying application. Format: Splash date (Y-m-d). Mapped to schema.org ParcelDelivery/expectedArrivalFrom.", "example": "2026-09-10" }, "refInternal": { "type": "string", "title": "Internal Ref.", "description": "Unique internal order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefInternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `name`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "name", "x-technical-description": "Internal unique reference of the order, generated by the remote application (e.g. 'CMD2024-0001'). Mapped to schema.org Order/name. Read-only by convention. Indexed and listed by default." }, "refCustomer": { "type": "string", "title": "Customer Ref.", "description": "Customer-side order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefCustomer::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderNumber`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderNumber", "x-technical-description": "Reference of the order on the customer side (e.g. a PO number). Mapped to schema.org Order/orderNumber. Indexed and listed by default." }, "refExternal": { "type": "string", "title": "External Ref.", "description": "External order reference\n\n- **Template:** `Splash\\Templates\\Order\\Core\\RefExternal::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `alternateName`\n- `\ud83d\udd0e Indexed`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "alternateName", "x-technical-description": "External reference of the order, typically coming from a third-party system (e.g. a marketplace order ID). Mapped to schema.org Order/alternateName. Indexed by default." }, "thirdParty__lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "thirdParty__firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "thirdParty__email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__firstname": { "type": "string", "title": "First Name", "description": "Contact Firstname\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Contact firstname, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/givenName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Firstname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__lastname": { "type": "string", "title": "Last Name", "description": "Contact Lastname / Family Name\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Contact lastname / family name, for Address definitions ONLY: postal address, billing address, delivery address. Mapped to schema.org Person/familyName \u2014 semantically correct mapping, http scheme preserved for automatic field pairing. Unlike the ThirdParty Lastname template, this field does NOT use the historical given/family swap: worst case, a legacy connector pairing only inverts firstname & lastname values." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "Email Address", "description": "Contact Email Address\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`", "x-splash-type": "email", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Contact Phone Number\n\n- **Template:** `Splash\\Templates\\Address\\Contact\\Phone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Contact phone number, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Phone template instead.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\Duns::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\TaxId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\Address\\Identifiers\\VatId::class`\n- **Microdata:** `https://schema.org/PostalAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "https://schema.org/PostalAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "items": { "type": "array", "title": "Items", "x-splash-list": "items", "items": { "type": "object", "properties": { "type": { "type": "string", "title": "Line Type", "description": "Normalized type of the line\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Type::class`\n- **Microdata:** `https://schema.org/OrderItem` \u2192 `additionalType`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "https://schema.org/OrderItem", "x-schema-org-itemprop": "additionalType", "enum": [ "product", "shipping", "fee", "option", "comment" ], "x-technical-description": "Qualifies WHAT the accounting line is, so that the receiving application does not have to guess it from the line label. Accepted values are Splash normalized codes from the AccountLineType dictionary: 'product' (sold product or service), 'shipping' (delivery charges), 'fee' (extra charge or global discount), 'option' (optional line, qty = 0 & price != 0), 'comment' (free text, qty = 1 & price = 0). An EMPTY value means a regular product line, so connectors that ignore this field keep working as before. Mapped to schema.org OrderItem/additionalType (https scheme: new field, no legacy pairing to preserve). Final type is varchar@list." }, "description": { "type": "string", "title": "Description", "description": "Line description\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Description::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `description`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "description", "x-technical-description": "Free-text description of the accounting line item (typically the product short description). Mapped to schema.org partOfInvoice/description. Final type is varchar@list." }, "productSku": { "type": "string", "title": "Product SKU", "description": "SKU of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductSku::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product attached to the accounting line. Mapped to schema.org Product/sku. Final type is varchar@list." }, "productName": { "type": "string", "title": "Product Name", "description": "Name of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductName::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `name`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "name", "x-technical-description": "Name of the product attached to the accounting line (typically a snapshot of the product name at the time of sale). Mapped to schema.org Product/name. Final type is varchar@list." }, "productMpn": { "type": "string", "title": "Supplier Ref.", "description": "Supplier reference (MPN) of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductMpn::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "mpn", "x-technical-description": "Manufacturer Part Number (MPN) of the product attached to the accounting line. Mapped to schema.org Product/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Quantity", "description": "Line quantity\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Quantity::class`\n- **Microdata:** `http://schema.org/QuantitativeValue` \u2192 `value`", "x-splash-type": "int@list", "format": "int@list", "x-schema-org-itemtype": "http://schema.org/QuantitativeValue", "x-schema-org-itemprop": "value", "x-technical-description": "Quantity of the accounting line item. Mapped to schema.org QuantitativeValue/value. Final type is int@list." }, "discount": { "type": "number", "title": "Discount (%)", "description": "Discount applied to the line, in percent\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Discount::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `discount`", "x-splash-type": "double@list", "format": "double@list", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "discount", "x-technical-description": "Percentage discount applied to the accounting line item. Mapped to schema.org Order/discount. Final type is double@list." }, "vatCode": { "type": "string", "title": "VAT Code", "description": "Code or name of the applicable VAT rate\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\VatCode::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `valueAddedTaxName`", "x-splash-type": "varchar@list", "format": "varchar@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "valueAddedTaxName", "x-technical-description": "Code or name of the VAT rate applied to the accounting line item (e.g. '20.0', 'TVA20', 'std'). Mapped to schema.org PriceSpecification/valueAddedTaxName. Final type is varchar@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product ID", "description": "Splash ID of the line product\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\ProductId::class`\n- **Microdata:** `http://schema.org/Product` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "x-schema-org-itemtype": "http://schema.org/Product", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash Object ID referencing the Product attached to the accounting line. Mapped to schema.org Product/productID. Final type is objectid::Product@list.", "example": "991::Product" }, "options": { "type": "string", "title": "Options", "description": "Line details (options, attributes, ...)\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\Options::class`\n- **Microdata:** `http://schema.org/partOfInvoice` \u2192 `options`", "x-splash-type": "inline@list", "format": "inline@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/partOfInvoice", "x-schema-org-itemprop": "options", "x-technical-description": "Line item options as an inline list of strings, one entry per visible option, formatted as 'key: value' (product variation attributes, personalization, add-ons, ...). Typically extracted from order line meta data by the connector. This field is read-only: options are informative and never written back. Mapped to schema.org partOfInvoice/options. Final type is inline@list." }, "unitPrice": { "allOf": [ { "$ref": "#/components/schemas/SplashPrice" } ], "title": "Unit Price", "description": "Line unit price\n\n- **Template:** `Splash\\Templates\\Accounting\\Items\\UnitPrice::class`\n- **Microdata:** `http://schema.org/PriceSpecification` \u2192 `price`", "x-splash-type": "price@list", "format": "price@list", "x-schema-org-itemtype": "http://schema.org/PriceSpecification", "x-schema-org-itemprop": "price", "x-technical-description": "Unit price of the accounting line item, expressed as a Splash price block (amount, VAT, currency, etc.). Mapped to schema.org PriceSpecification/price. Final type is price@list.", "example": { "base": 0, "ht": 65.76, "vat": 20, "tax": 13.15, "ttc": 78.91, "code": "EUR", "symbol": "\u20ac", "name": "Euro" } } } } }, "receptions": { "type": "array", "title": "Receptions", "x-splash-list": "receptions", "items": { "type": "object", "properties": { "productMpn": { "type": "string", "title": "Product MPN", "description": "Supplier reference of the product\n\n- **Template:** `Splash\\Templates\\Accounting\\Receptions\\ProductMpn::class`\n- **Microdata:** `http://schema.org/OrderItem` \u2192 `mpn`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderItem", "x-schema-org-itemprop": "mpn", "x-technical-description": "MPN (Manufacturer Part Number) of the product to receive: the reference used by the supplier on its own documents. Part of the receptions list of a supplier order: one entry per product to receive, tracking what was ordered against what was actually delivered. Read-only, the warehouse application owns it. Mapped to schema.org OrderItem/mpn. Final type is varchar@list." }, "quantity": { "type": "integer", "title": "Ordered Quantity", "description": "Quantity ordered to the supplier\n\n- **Template:** `Splash\\Templates\\Accounting\\Receptions\\Quantity::class`\n- **Microdata:** `http://schema.org/OrderItem` \u2192 `orderQuantity`", "x-splash-type": "int@list", "format": "int@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderItem", "x-schema-org-itemprop": "orderQuantity", "x-technical-description": "Quantity ordered to the supplier, the target to reach for this reception line. Part of the receptions list of a supplier order: one entry per product to receive, tracking what was ordered against what was actually delivered. Read-only, the warehouse application owns it. Mapped to schema.org OrderItem/orderQuantity. Final type is int@list." }, "receivedQuantity": { "type": "integer", "title": "Received Quantity", "description": "Quantity actually received\n\n- **Template:** `Splash\\Templates\\Accounting\\Receptions\\ReceivedQuantity::class`\n- **Microdata:** `http://schema.org/OrderItem` \u2192 `orderItemStatus`", "x-splash-type": "int@list", "format": "int@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderItem", "x-schema-org-itemprop": "orderItemStatus", "x-technical-description": "Quantity actually received in the warehouse. Compared to the ordered quantity, it tells whether the reception is complete, partial or pending. Part of the receptions list of a supplier order: one entry per product to receive, tracking what was ordered against what was actually delivered. Read-only, the warehouse application owns it. Mapped to schema.org OrderItem/orderItemStatus. Final type is int@list." }, "productId": { "type": "string", "format": "objectid::Product@list", "title": "Product", "description": "Product expected in the reception\n\n- **Template:** `Splash\\Templates\\Accounting\\Receptions\\ProductId::class`\n- **Microdata:** `http://schema.org/OrderItem` \u2192 `productID`", "x-splash-type": "objectid::Product@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderItem", "x-schema-org-itemprop": "productID", "x-technical-description": "Splash object ID of the product to receive. Part of the receptions list of a supplier order: one entry per product to receive, tracking what was ordered against what was actually delivered. Read-only, the warehouse application owns it. Mapped to schema.org OrderItem/productID. Final type is objectid::Product@list.", "example": "334::Product" }, "productSku": { "type": "string", "title": "Product SKU", "description": "Internal reference of the product to receive\n\n- **Template:** `Splash\\Templates\\Accounting\\Receptions\\ProductSku::class`\n- **Microdata:** `http://schema.org/OrderItem` \u2192 `sku`", "x-splash-type": "varchar@list", "format": "varchar@list", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/OrderItem", "x-schema-org-itemprop": "sku", "x-technical-description": "SKU (Stock Keeping Unit) of the product to receive, as known by the buying application. Part of the receptions list of a supplier order: one entry per product to receive, tracking what was ordered against what was actually delivered. Read-only, the warehouse application owns it. Mapped to schema.org OrderItem/sku. Final type is varchar@list." } } } } }, "required": [ "date", "refCustomer" ] }, "SupplierOrderListItem": { "type": "object", "title": "SupplierOrder (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "date": { "type": "string", "format": "date", "title": "Order Date" }, "refInternal": { "type": "string", "title": "Internal Ref." }, "refCustomer": { "type": "string", "title": "Customer Ref." } } }, "ThirdParty": { "type": "object", "title": "ThirdParty", "description": "Sample Customer Object to Expose Splash Scopes: identity,\nidentifiers, marketing flags & owned addresses.\n\n#### Addresses Modes\n\nThree address levels may coexist on a Customer:\n\n| Block | Fields | Microdata | Usage |\n|---|---|---|---|\n| **Generic** | unprefixed (`streetAddress`, ...) | `schema.org/PostalAddress` | Main \u2014 billing details by convention |\n| **Billing Contact** | `billingAddress__*` | `schema.org/billingAddress` | Optional dedicated billing contact |\n| **Shipping Contact** | `shippingAddress__*` | `schema.org/deliveryAddress` | Optional dedicated delivery contact |\n\nContacts may also be exposed as standalone Address objects, linked from the\nCustomer via `billingAddressId` / `shippingAddressId` (`objectid::Address`).\n\n#### Recommended Sync Strategy\n\n- **Preferred**: sync the generic block on the Customer, and manage the\noptional contacts as standalone Address objects, using the `objectid`\nlinks.\n- **One-shot**: expose the `billingAddress__*` / `shippingAddress__*`\nblocks to sync the Customer and both contacts in a single call.\n\nAvoid mixing both write channels (`objectid` link and `__` block) for the\nsame address in a single request.\n\n#### Identifiers\n\nCompany identifiers follow `schema.org` semantics: `duns` (SIREN in France),\n`vatId` (EU VAT number), `taxId` (national tax ID), `naics` & `isicV4`\n(activity classifications).\n\n#### Primary Key\n\n`email` is the recommended primary field for customers, but any unique\nfield may fit, depending on the connector context (i.e. phone number).\n ", "x-splash-type": "ThirdParty", "properties": { "username": { "type": "string", "title": "User name", "description": "ThirdParty or Company Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Name::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `legalName`\n- `\ud83d\udd0e Indexed` `\ud83d\udccb In List` `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "legalName", "x-technical-description": "Primary identification name of the ThirdParty. For a company: the legal name (e.g. 'Acme Corp'). For an individual: the username or display name. Mapped to schema.org Organization/legalName. This field is required, indexed, listed and logged by default. It is the main identifier shown in lists and search results. Also available via AddressFields for address contact identification." }, "lastname": { "type": "string", "title": "Last Name", "description": "Person Lastname / Familly Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Lastname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "firstname": { "type": "string", "title": "First Name", "description": "Person Firstname\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Firstname::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "email": { "type": "string", "format": "email", "title": "Email Address", "description": "ThirdParty Email Address\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Email::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `email`\n- `\ud83d\udd11 Primary` `\ud83d\udd0e Indexed` `\ud83d\udccb In List`", "x-splash-type": "email", "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "email", "x-technical-description": "ThirdParty primary email address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email. Indexed and listed by default, commonly used as a primary key for matching ThirdParties across systems. Also available via AddressFields for address contact email." }, "phone": { "type": "string", "format": "phone", "title": "Phone", "description": "Person Phone\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Phone::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "mobilePhone": { "type": "string", "format": "phone", "title": "Mobile Phone", "description": "Person Mobile Phone\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\MobilePhone::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "telephone", "x-technical-description": "Mobile or cellular phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org Person/telephone. Distinguished from PHONE (PostalAddress/telephone) by the itemtype: MOBILE uses Person/telephone, PHONE uses PostalAddress/telephone. When a connector only has one phone field, prefer mapping it to PHONE.", "example": "+33612345678" }, "fax": { "type": "string", "format": "phone", "title": "Fax", "description": "Fax Number\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Core\\Fax::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `faxNumber`", "x-splash-type": "phone", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "faxNumber", "x-technical-description": "Organization fax number. Splash type is 'phone', no strict format validation. Mapped to schema.org Organization/faxNumber.", "example": "+33612345678" }, "gender": { "type": "string", "title": "Civility Type", "description": "Normalized Civility Type\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Profile\\CivilityType::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `gender`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "gender", "enum": [ "m", "f", "n" ], "x-technical-description": "Normalized civility type code. Mapped to schema.org Person/gender. Accepted values are Splash normalized: 'male', 'female', 'neutral' (from Civility dictionary). The connector must convert its local civility codes to/from these normalized values using Civility::toSplash() and Civility::toApp(). The writable code field, use CIVILITY_NAME for the read-only human-readable label." }, "genderName": { "type": "string", "title": "Civility Name", "description": "Civility Type Name\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Profile\\CivilityName::class`\n- **Microdata:** `http://schema.org/Person` \u2192 `honorificPrefix`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/Person", "x-schema-org-itemprop": "honorificPrefix", "x-technical-description": "Human-readable civility label (e.g. 'Mr', 'Mrs', 'Mx'). Read-only field, derived from the CIVILITY code by the connector. Mapped to schema.org Person/honorificPrefix. To change the civility, write to the CIVILITY (type code) field instead." }, "url": { "type": "string", "format": "url", "title": "Website Url", "description": "Website / Profile Url\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Profile\\Website::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `url`", "x-splash-type": "url", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "url", "x-technical-description": "Website or profile URL of the ThirdParty. Splash type is 'url', expects a fully qualified URL (e.g. 'https://example.com'). Mapped to schema.org Organization/url. Can represent a company website, personal homepage, or social media profile link." }, "dateCreated": { "type": "string", "format": "datetime", "title": "Date Created", "description": "Object creation date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateCreated::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateCreated`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateCreated", "x-technical-description": "Creation datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is set once at object creation by the remote application. Used for audit trail purposes and to determine object age. This field is mapped to schema.org DataFeedItem/dateCreated. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track creation dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "dateModified": { "type": "string", "format": "datetime", "title": "Date Modified", "description": "Last modification date\n\n- **Template:** `Splash\\Templates\\Common\\Audit\\DateModified::class`\n- **Microdata:** `http://schema.org/DataFeedItem` \u2192 `dateModified`", "x-splash-type": "datetime", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/DataFeedItem", "x-schema-org-itemprop": "dateModified", "x-technical-description": "Last modification datetime of the object on the remote application. Format: Splash datetime (Y-m-d H:i:s). This field is always read-only, the value is managed by the remote application. This field is purely informational, it is NOT used for change detection. Splash only triggers synchronization when a commit notification is received from the remote application. This field is mapped to schema.org DataFeedItem/dateModified. Available on all object types (ThirdParty, Address, Product, Order, Invoice). If the remote application does not track modification dates, this field should not be exposed.", "example": "2026-09-10 15:17:04" }, "objectId": { "type": "string", "title": "Splash ID", "description": "Splash unique object identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\ObjectId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `ObjectId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "ObjectId", "x-technical-description": "UUID assigned by Splash when the object is first synchronized. Stored locally by the connector to track the object across systems. Mapped to splashync.com/schemas ObjectId. Format is a standard UUID string (e.g. '550e8400-e29b-41d4-a716-446655440000'). This field is read-write: Splash writes the UUID on first sync, the connector reads it back on subsequent syncs for identification. Available on all object types." }, "syncDateCreated": { "type": "string", "format": "datetime", "title": "Splash Created Date", "description": "Date of first Splash synchronization\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\DateCreated::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `DateCreated`", "x-splash-type": "datetime", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "DateCreated", "x-technical-description": "Date when the object was first synchronized by Splash. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas DateCreated. Available on all object types.", "example": "2026-09-10 15:17:04" }, "originNodeId": { "type": "string", "title": "Source Server ID", "description": "Splash source server identifier\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeId::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeId`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeId", "x-technical-description": "Integer ID of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeId. Available on all object types." }, "originNodeName": { "type": "string", "title": "Source Server Name", "description": "Splash source server name\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\OriginNodeName::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `SourceNodeName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "SourceNodeName", "x-technical-description": "Human-readable name of the Splash server that originally created the object. Written by Splash on first sync, stored locally by the connector. Mapped to splashync.com/schemas SourceNodeName. Available on all object types." }, "presence": { "type": "boolean", "title": "Splash Presence", "description": "Object presence indicator on remote server\n\n- **Prefer Write** \u2014 field should only be written & imported from other servers\n- **Template:** `Splash\\Templates\\Common\\Sync\\Presence::class`\n- **Microdata:** `http://splashync.com/schemas` \u2192 `Presence`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://splashync.com/schemas", "x-schema-org-itemprop": "Presence", "x-technical-description": "Presence flag for remote object lifecycle management. When set but empty, the remote object should be deleted. Default Splash type is bool, which is the recommended one. The feature works exactly the same when the connector exposes it as a varchar: the engine only evaluates the received value as empty or not, so both types are equally valid and interchangeable. Mapped to splashync.com/schemas Presence. Available on all object types." }, "billingAddressId": { "type": "string", "format": "objectid::Address", "title": "Billing Address", "description": "Billing address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\BillingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `billingAddress`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "billingAddress", "x-technical-description": "Splash object ID linking this accounting document to its billing Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/billingAddress.", "example": "725::Address" }, "shippingAddressId": { "type": "string", "format": "objectid::Address", "title": "Shipping Address", "description": "Shipping address of the document\n\n- **Template:** `Splash\\Templates\\Accounting\\Core\\ShippingAddress::class`\n- **Microdata:** `http://schema.org/Order` \u2192 `orderDelivery`", "x-splash-type": "objectid::Address", "x-schema-org-itemtype": "http://schema.org/Order", "x-schema-org-itemprop": "orderDelivery", "x-technical-description": "Splash object ID linking this accounting document to its shipping Address. Type is objectid::Address, value format is the Splash-encoded object ID. Use ObjectsHelper::encode('Address', $rawId) to write and ObjectsHelper::id($value) to read. Mapped to schema.org Order/orderDelivery.", "example": "135::Address" }, "identifier": { "type": "string", "title": "Customer Code", "description": "Unique code identifying the customer in the application\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\Identifier::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `identifier`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "identifier", "x-technical-description": "Internal customer code of the organization. Application specific identifier, often auto-generated by the business application (e.g. CU2607-00001). This is an identifier, not a name: the commercial name or brand belongs to the AlternateName template. Mapped to schema.org Organization/identifier. Usually read-only when generated by the application. Grouped under 'ID' by convention." }, "fiscalIdentifier": { "type": "string", "title": "Accountancy Code", "description": "Customer accountancy account code\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\FiscalIdentifier::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `fiscalIdentifier`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "fiscalIdentifier", "x-technical-description": "Accountancy account code of the organization, used by the accounting system to post customer entries. Mapped to schema.org Organization/fiscalIdentifier. Grouped under 'ID' by convention." }, "taxId": { "type": "string", "title": "Tax ID", "description": "Organization Tax Identification Number\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\TaxId::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID." }, "vatId": { "type": "string", "title": "VAT Number", "description": "Intra-community VAT Number\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\VatId::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance." }, "duns": { "type": "string", "title": "Company Number / DUNS", "description": "Company Number / DUNS Identifier\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\Duns::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland." }, "naics": { "type": "string", "title": "NAICS / APE Code", "description": "Activity Classification Code (NAICS / APE)\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\Naics::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `naics`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "naics", "x-technical-description": "Activity classification code. NAICS in North America, APE/NAF in France. Mapped to schema.org Organization/naics." }, "isicV4": { "type": "string", "title": "ISIC v4 Code", "description": "ISIC v4 Activity Classification Code\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Identifiers\\IsicV4::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `isicV4`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "isicV4", "x-technical-description": "International Standard Industrial Classification (ISIC) revision 4 code. Mapped to schema.org Organization/isicV4. UN-maintained classification used internationally." }, "active": { "type": "boolean", "title": "Active", "description": "ThirdParty is active\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Flags\\Active::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `active`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "active", "x-technical-description": "Boolean flag indicating if the ThirdParty is active. Mapped to schema.org Organization/active. An inactive ThirdParty is typically archived or disabled and should not appear in default lists." }, "prospect": { "type": "boolean", "title": "Prospect", "description": "ThirdParty is a prospect\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Flags\\Prospect::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `prospect`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "prospect", "x-technical-description": "Boolean flag indicating if the ThirdParty is a prospect. Mapped to schema.org Organization/prospect. A prospect is a potential customer that has not yet placed an order. Not all connectors distinguish prospects from customers." }, "customer": { "type": "boolean", "title": "Customer", "description": "ThirdParty is a customer\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Flags\\Customer::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `customer`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "customer", "x-technical-description": "Boolean flag indicating if the ThirdParty is a customer. Mapped to schema.org Organization/customer. A customer is a ThirdParty that has placed at least one order. On e-commerce connectors, all ThirdParties are typically customers." }, "supplier": { "type": "boolean", "title": "Supplier", "description": "ThirdParty is a supplier\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Flags\\Supplier::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `supplier`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "supplier", "x-technical-description": "Boolean flag indicating if the ThirdParty is a supplier. Mapped to schema.org Organization/supplier. A supplier provides goods or services to the organization." }, "useVat": { "type": "boolean", "title": "VAT Subject", "description": "ThirdParty is subject to VAT\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Flags\\UseVat::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `UseVAT`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "UseVAT", "x-technical-description": "Boolean flag indicating if the ThirdParty is subject to VAT. Mapped to schema.org Organization/UseVAT. When true, invoices for this ThirdParty should include VAT." }, "newsletter": { "type": "boolean", "title": "Newsletter", "description": "Newsletter subscription\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Marketing\\Newsletter::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `newsletter`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "newsletter", "x-technical-description": "Boolean flag indicating if the ThirdParty subscribed to the newsletter. Mapped to schema.org Organization/newsletter." }, "advertising": { "type": "boolean", "title": "Advertising Opt-in", "description": "Accepts advertising communications\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Marketing\\Advertising::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `advertising`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "advertising", "x-technical-description": "Boolean flag indicating if the ThirdParty opted in for advertising communications. Mapped to schema.org Organization/advertising. Must comply with GDPR consent requirements." }, "noEmail": { "type": "boolean", "title": "Email Opt-Out", "description": "Email sending blocked for this contact\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Marketing\\NoEmail::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `emailOptOut`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "emailOptOut", "x-technical-description": "Boolean flag indicating if the ThirdParty has opted out of email communications. Used by mailers (Brevo, Mailchimp, etc.) to block all email sending to a customer. When true, no marketing or transactional emails should be sent to this contact. Mapped to schema.org ContactPoint/emailOptOut (custom property)." }, "noSms": { "type": "boolean", "title": "SMS Opt-Out", "description": "SMS sending blocked for this contact\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Marketing\\NoSms::class`\n- **Microdata:** `http://schema.org/ContactPoint` \u2192 `smsOptOut`", "x-splash-type": "bool", "format": "bool", "x-schema-org-itemtype": "http://schema.org/ContactPoint", "x-schema-org-itemprop": "smsOptOut", "x-technical-description": "Boolean flag indicating if the ThirdParty has opted out of SMS communications. Used by mailers (Brevo, Mailchimp, etc.) to block all SMS sending to a customer. When true, no marketing or transactional SMS should be sent to this contact. Mapped to schema.org ContactPoint/smsOptOut (custom property)." }, "mailingListName": { "type": "string", "title": "Mailing List", "description": "Name of the mailing list\n\n- **Template:** `Splash\\Templates\\ThirdParty\\Marketing\\MailingListName::class`\n- **Microdata:** `http://schema.org/Organization` \u2192 `mailingListNames`", "x-splash-type": "inline", "format": "inline", "x-schema-org-itemtype": "http://schema.org/Organization", "x-schema-org-itemprop": "mailingListNames", "x-technical-description": "Name of the mailing list the ThirdParty is subscribed to. Used by mailers (Brevo, Mailchimp, etc.) to identify the distribution list. Mapped to schema.org Organization/mailingListNames (custom property)." }, "streetAddress": { "type": "string", "title": "[ADD1] Street address", "description": "The street address. For example, 1600 Amphitheatre Pkwy.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\StreetAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "postOfficeBoxNumber": { "type": "string", "title": "[ADD2] Post office box number", "description": "The post office box number for PO box addresses. For example, DN7524.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostOfficeBoxNumber::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "extendedAddress": { "type": "string", "title": "[ADD3] Address extension", "description": "An address extension such as an apartment number, C/O or alternative name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\ExtendedAddress::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "locality": { "type": "string", "title": "Locality", "description": "The locality in which the street address is, and which is in the region. I.e, Mountain View.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\Locality::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "postalCode": { "type": "string", "title": "Postal Code", "description": "The postal code. For example, 94043.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\PostalCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "region": { "type": "string", "format": "state", "title": "Region / State Code", "description": "Code of region or state in which the locality is, and which is in the country.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\RegionCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "country": { "type": "string", "format": "country", "title": "Country ISO code", "description": "The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryCode::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__company": { "type": "string", "title": "[BA] Company", "description": "Billing :Company\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Name::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `legalName`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "legalName", "x-technical-description": "Primary identification name of the ThirdParty. For a company: the legal name (e.g. 'Acme Corp'). For an individual: the username or display name. Mapped to schema.org Organization/legalName. This field is required, indexed, listed and logged by default. It is the main identifier shown in lists and search results. Also available via AddressFields for address contact identification." }, "billingAddress__firstname": { "type": "string", "title": "[BA] First Name", "description": "Billing :First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Firstname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "billingAddress__lastname": { "type": "string", "title": "[BA] Last Name", "description": "Billing :Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Lastname::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "billingAddress__email": { "type": "string", "format": "email", "title": "[BA] Email Address", "description": "Billing :Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Email::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `email`", "x-splash-type": "email", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "billingAddress__phone": { "type": "string", "format": "phone", "title": "[BA] Phone", "description": "Billing :Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Phone::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "billingAddress__streetAddress": { "type": "string", "title": "[BA] [ADD1] Street address", "description": "Billing :[ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\StreetAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "billingAddress__postOfficeBoxNumber": { "type": "string", "title": "[BA] [ADD2] Post office box number", "description": "Billing :[ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "billingAddress__extendedAddress": { "type": "string", "title": "[BA] [ADD3] Address extension", "description": "Billing :[ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "billingAddress__postalCode": { "type": "string", "title": "[BA] Postal Code", "description": "Billing :Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\PostalCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "billingAddress__addressLocality": { "type": "string", "title": "[BA] Locality", "description": "Billing :Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Locality::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "billingAddress__addressRegion": { "type": "string", "format": "state", "title": "[BA] Region / State Code", "description": "Billing :Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\RegionCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "billingAddress__addressCountry": { "type": "string", "format": "country", "title": "[BA] Country ISO code", "description": "Billing :Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\CountryCode::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "billingAddress__duns": { "type": "string", "title": "[BA] Company Number / DUNS", "description": "Billing :Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\Duns::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "billingAddress__taxId": { "type": "string", "title": "[BA] Tax ID", "description": "Billing :Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\TaxId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "billingAddress__vatId": { "type": "string", "title": "[BA] VAT Number", "description": "Billing :VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Billing\\VatId::class`\n- **Microdata:** `https://schema.org/billingAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/billingAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "shippingAddress__company": { "type": "string", "title": "[DA] Company", "description": "Delivery : Company\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Name::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `legalName`\n- `\ud83d\udcdc Logged`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "legalName", "x-technical-description": "Primary identification name of the ThirdParty. For a company: the legal name (e.g. 'Acme Corp'). For an individual: the username or display name. Mapped to schema.org Organization/legalName. This field is required, indexed, listed and logged by default. It is the main identifier shown in lists and search results. Also available via AddressFields for address contact identification." }, "shippingAddress__firstname": { "type": "string", "title": "[DA] First Name", "description": "Delivery : First Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Firstname::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `familyName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "familyName", "x-technical-description": "Person firstname. Mapped to schema.org Person/familyName (historical Splash convention, itemprop is swapped with Lastname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's firstname to this field despite the itemprop name." }, "shippingAddress__lastname": { "type": "string", "title": "[DA] Last Name", "description": "Delivery : Last Name\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Lastname::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `givenName`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "givenName", "x-technical-description": "Person lastname / family name. Mapped to schema.org Person/givenName (historical Splash convention, itemprop is swapped with Firstname). This swap is intentional and must be preserved for backward compatibility with all existing connectors. When building a new connector, map the person's lastname to this field despite the itemprop name." }, "shippingAddress__email": { "type": "string", "format": "email", "title": "[DA] Email Address", "description": "Delivery : Email Address\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Email::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `email`", "x-splash-type": "email", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "email", "x-technical-description": "Contact email address, for Address definitions ONLY: postal address, billing address, delivery address. Splash type is 'email', validated as a valid email format. Mapped to schema.org ContactPoint/email \u2014 historical Splash mapping shared by ALL existing connectors, preserved as-is (http scheme included) for automatic field pairing. In a ThirdParty context, use the ThirdParty Email template instead, indexed and commonly used as a primary key for matching across systems." }, "shippingAddress__phone": { "type": "string", "format": "phone", "title": "[DA] Phone", "description": "Delivery : Phone\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Phone::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `telephone`", "x-splash-type": "phone", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "telephone", "x-technical-description": "Home or landline phone number. Splash type is 'phone', no strict format validation. Mapped to schema.org PostalAddress/telephone. Distinguished from MOBILE (Person/telephone) by the itemtype: PHONE uses PostalAddress/telephone, MOBILE uses Person/telephone. Some connectors expose additional phone fields (e.g. phone_pro), those should be mapped to this template when they represent the primary landline.", "example": "+33612345678" }, "shippingAddress__streetAddress": { "type": "string", "title": "[DA] [ADD1] Street address", "description": "Delivery : [ADD1] Street address\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\StreetAddress::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `streetAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "streetAddress", "x-technical-description": "Primary street address line (address line 1). Contains the street number, name and type (e.g. '1600 Amphitheatre Pkwy'). Mapped to schema.org PostalAddress/streetAddress. Grouped under 'Address' in field definitions. Some connectors may concatenate multiple address lines into this single field. When writing, only the primary street line should be set here, use POST_OFFICE_BOX_NUMBER and EXTENDED for additional lines." }, "shippingAddress__postOfficeBoxNumber": { "type": "string", "title": "[DA] [ADD2] Post office box number", "description": "Delivery : [ADD2] Post office box number\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\PostOfficeBoxNumber::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `postOfficeBoxNumber`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "postOfficeBoxNumber", "x-technical-description": "Secondary address line (address line 2). Originally intended for PO box numbers, but commonly used as a generic second address line. Mapped to schema.org PostalAddress/postOfficeBoxNumber. Grouped under 'Address' in field definitions. Connectors should map their 'address line 2' or 'PO box' field here." }, "shippingAddress__extendedAddress": { "type": "string", "title": "[DA] [ADD3] Address extension", "description": "Delivery : [ADD3] Address extension\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\ExtendedAddress::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `extendedAddress`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "extendedAddress", "x-technical-description": "Tertiary address line (address line 3). Used for additional address details such as apartment number, building, C/O, or alternative name. Mapped to schema.org PostalAddress/extendedAddress. Grouped under 'Address' in field definitions. Not all connectors support a third address line, this field may be ignored on write." }, "shippingAddress__postalCode": { "type": "string", "title": "[DA] Postal Code", "description": "Delivery : Postal Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\PostalCode::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `postalCode`\n- **Options:**\n - **maxLength** => 15", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "postalCode", "x-technical-description": "Postal or ZIP code. Format varies by country (e.g. '75001' for France, '94043' for US, 'SW1A 1AA' for UK). Mapped to schema.org PostalAddress/postalCode. Grouped under 'Address' in field definitions. Maximum length constrained to 15 characters. This field is never validated against a country-specific format by Splash." }, "shippingAddress__addressLocality": { "type": "string", "title": "[DA] Locality", "description": "Delivery : Locality\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Locality::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `addressLocality`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "addressLocality", "x-technical-description": "City or locality name. Free-text value, not normalized (e.g. 'Paris', 'Mountain View', 'London'). Mapped to schema.org PostalAddress/addressLocality. Grouped under 'Address' in field definitions. This is a plain text city name, not a code or ID." }, "shippingAddress__addressRegion": { "type": "string", "format": "state", "title": "[DA] Region / State Code", "description": "Delivery : Region / State Code\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\RegionCode::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `addressRegion`", "x-splash-type": "state", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "addressRegion", "x-technical-description": "Region, state or department code. Splash type is 'state', expects the local subdivision code without country prefix (e.g. '33' for France, 'CA' for US). Mapped to schema.org PostalAddress/addressRegion. Grouped under 'Address' in field definitions. The writable code field, use REGION_NAME for the read-only human-readable label." }, "shippingAddress__addressCountry": { "type": "string", "format": "country", "title": "[DA] Country ISO code", "description": "Delivery : Country ISO code\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\CountryCode::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `addressCountry`", "x-splash-type": "country", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "addressCountry", "x-technical-description": "Country ISO code. Splash type is 'country', expects ISO 3166-1 alpha-2 format (e.g. 'FR', 'US', 'DE'). For backward compatibility, ISO 3166-1 alpha-3 codes (e.g. 'FRA', 'SGP') may also be accepted. Mapped to schema.org PostalAddress/addressCountry. Grouped under 'Address' in field definitions. The writable code field, use COUNTRY_NAME for the read-only human-readable label." }, "shippingAddress__duns": { "type": "string", "title": "[DA] Company Number / DUNS", "description": "Delivery : Company Number / DUNS\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\Duns::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `duns`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "duns", "x-technical-description": "Dun & Bradstreet DUNS number of the organization. Worldwide unique identifier assigned by Dun & Bradstreet to each legal entity or site: 9 digits (e.g. 150483782), often displayed as XX-XXX-XXXX. Mapped to schema.org Organization/duns. Used internationally for B2B identification, credit reporting and public procurement. Historical Splash convention: when no true DUNS is available, connectors store the national company registry identifier here. Name varies by country: SIREN in France (9 digits, company-level), BCE/KBO number in Belgium, Handelsregisternummer in Germany, Company Number in the UK, REA number in Italy, CIF in Spain, KvK number in the Netherlands, UID (CHE) in Switzerland. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/duns. In a ThirdParty context, use the parent ThirdParty Duns template instead (Organization/duns)." }, "shippingAddress__taxId": { "type": "string", "title": "[DA] Tax ID", "description": "Delivery : Tax ID\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\TaxId::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `taxID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "taxID", "x-technical-description": "Tax identification number of the organization. Format varies by country: SIRET in France (14 digits), EIN in the US, Company Number in the UK. Mapped to schema.org Organization/taxID. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/taxID. In France this is the SIRET (14 digits): one per establishment, i.e. per address \u2014 while the company-level SIREN belongs to the ThirdParty. In a ThirdParty context, use the parent ThirdParty TaxId template instead (Organization/taxID)." }, "shippingAddress__vatId": { "type": "string", "title": "[DA] VAT Number", "description": "Delivery : VAT Number\n\n- **Template:** `Splash\\Templates\\Accounting\\Delivery\\VatId::class`\n- **Microdata:** `https://schema.org/deliveryAddress` \u2192 `vatID`", "x-splash-type": "varchar", "format": "varchar", "x-schema-org-itemtype": "https://schema.org/deliveryAddress", "x-schema-org-itemprop": "vatID", "x-technical-description": "Intra-community VAT identification number. Format varies by country (e.g. FR12345678901 for France, DE123456789 for Germany, GB123456789 for UK). Mapped to schema.org Organization/vatID. Maximum length 20 characters. Used for B2B invoicing and tax compliance. PostalAddress variant of this identifier, for Address definitions ONLY: postal address, billing address, delivery address \u2014 here mapped to schema.org PostalAddress/vatID. In a ThirdParty context, use the parent ThirdParty VatId template instead (Organization/vatID)." }, "countryName": { "type": "string", "title": "Country name", "description": "The country name.\n\n- **Template:** `Splash\\Templates\\Address\\PostalAddress\\CountryName::class`\n- **Microdata:** `http://schema.org/PostalAddress` \u2192 `addressCountryName`", "x-splash-type": "varchar", "format": "varchar", "readOnly": true, "x-schema-org-itemtype": "http://schema.org/PostalAddress", "x-schema-org-itemprop": "addressCountryName", "x-technical-description": "Human-readable country name. Read-only field, derived from the COUNTRY code by the connector. Mapped to schema.org PostalAddress/addressCountryName. Grouped under 'Address' in field definitions. This field is never synchronized, it is purely informational. To change the country, write to the COUNTRY (code) field instead." } }, "required": [ "username", "email" ] }, "ThirdPartyListItem": { "type": "object", "title": "ThirdParty (List Item)", "description": "Fields returned by objects list requests \u2014 fields flagged `In List` only.", "properties": { "username": { "type": "string", "title": "User name" }, "email": { "type": "string", "format": "email", "title": "Email Address" } } } } } }