Objects

Details of All Available Objects

Definition


Canonical Type ThirdParty Objects Name Company
Description Sellsy Company API Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Type type  VARCHAR Type
Splash Presence presence  BOOL Object presence indicator on remote server
User name name  VARCHAR ThirdParty or Company Name
First Name firstName  VARCHAR Person Firstname
Last Name lastName  VARCHAR Person Lastname / Familly Name
Customer Code reference  VARCHAR Unique code identifying the customer in the application
Email Address email  EMAIL ThirdParty Email Address
Website Url website  URL Website / Profile Url
Phone phoneNumber  PHONE Person Phone
Mobile Phone mobileNumber  PHONE Person Mobile Phone
Fax faxNumber  PHONE Fax Number
Capital capital  VARCHAR Capital
Note note  VARCHAR Note
Twitter social__twitter  URL [Social] Company Twitter Page
Facebook social__facebook  URL [Social] Company Facebook Page
Linkedin social__linkedin  URL [Social] Company LinkedIn Page
Viadeo social__viadeo  URL [Social] Company Viadeo Page
Tax ID legalFrance__siret  VARCHAR Organization Tax Identification Number
Company Number / DUNS legalFrance__siren  VARCHAR Company Number / DUNS Identifier
VAT Number legalFrance__vat  VARCHAR Intra-community VAT Number
NAICS / APE Code legalFrance__apeNafCode  VARCHAR Activity Classification Code (NAICS / APE)
Company Type legalFrance__companyType  VARCHAR Company Type
ISIC v4 Code legalFrance__rcsImmatriculation  VARCHAR ISIC v4 Activity Classification Code
Company invoicingAddress__name  VARCHAR Company Name, leave empty for individuals
[ADD1] Street address invoicingAddress__addressFirstLine  VARCHAR The street address. For example, 1600 Amphitheatre Pkwy.
[ADD2] Post office box number invoicingAddress__addressSecondLine  VARCHAR The post office box number for PO box addresses. For example, DN7524.
[ADD3] Address extension invoicingAddress__addressThirdLine  VARCHAR An address extension such as an apartment number, C/O or alternative name.
[ADD4] Address extension invoicingAddress__addressFourthLine  VARCHAR Fourth line of the address
Postal Code invoicingAddress__postalCode  VARCHAR The postal code. For example, 94043.
Locality invoicingAddress__city  VARCHAR The locality in which the street address is, and which is in the region. I.e, Mountain View.
Country name invoicingAddress__country  VARCHAR The country name.
Country ISO code invoicingAddress__countryCode  ISO COUNTRY The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.
Is Invoicing invoicingAddress__isInvoicingAddress  BOOL Is address invoicing address ?
Is Delivery invoicingAddress__isDeliveryAddress  BOOL Is address delivery address ?
Latitude invoicingAddress__latitude  DOUBLE [Geocode] Address Latitude
Longitude invoicingAddress__longitude  DOUBLE [Geocode] Address Longitude
[DA] Company deliveryAddress__name  VARCHAR Delivery : Company
[DA] [ADD1] Street address deliveryAddress__addressFirstLine  VARCHAR Delivery : [ADD1] Street address
[DA] [ADD2] Post office box number deliveryAddress__addressSecondLine  VARCHAR Delivery : [ADD2] Post office box number
[DA] [ADD3] Address extension deliveryAddress__addressThirdLine  VARCHAR Delivery : [ADD3] Address extension
[DA] Postal Code deliveryAddress__postalCode  VARCHAR Delivery : Postal Code
[DA] Locality deliveryAddress__city  VARCHAR Delivery : Locality
[DA] Country name deliveryAddress__country  VARCHAR Delivery : Country name
[DA] Country ISO code deliveryAddress__countryCode  ISO COUNTRY Delivery : Country ISO code
[ADD4] Address extension deliveryAddress__addressFourthLine  VARCHAR Fourth line of the address
Is Invoicing deliveryAddress__isInvoicingAddress  BOOL Is address invoicing address ?
Is Delivery deliveryAddress__isDeliveryAddress  BOOL Is address delivery address ?
Latitude deliveryAddress__latitude  DOUBLE [Geocode] Address Latitude
Longitude deliveryAddress__longitude  DOUBLE [Geocode] Address Longitude
IsArchived isArchived  BOOL IsArchived
Date Created created  DATETIME Object creation date
Date Modified updatedAt  DATETIME Last modification date

Definition


Canonical Type Address Objects Name Contact
Description Sellsy Contacts Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Splash Presence presence  BOOL Object presence indicator on remote server
Civility Type civility  VARCHAR Normalized Civility Type
First Name first_name  VARCHAR Contact Firstname
Last Name last_name  VARCHAR Contact Lastname / Family Name
Position position  VARCHAR Position
Email Address email  EMAIL Contact Email Address
Website Url website  URL Website / Profile Url
Phone phoneNumber  PHONE Contact Phone Number
Mobile Phone mobileNumber  PHONE Person Mobile Phone
Fax faxNumber  PHONE Fax Number
Notes note  VARCHAR Address notes or remarks
Twitter social__twitter  URL [Social] Company Twitter Page
Facebook social__facebook  URL [Social] Company Facebook Page
Linkedin social__linkedin  URL [Social] Company LinkedIn Page
Viadeo social__viadeo  URL [Social] Company Viadeo Page
Mailchimp sync__mailchimp  BOOL [Sync] Activate the mailchimp synchronization
Mailjet sync__mailjet  BOOL [Sync] Activate the mailjet synchronization
Simplemail sync__simplemail  BOOL [Sync] Activate the Simple Mail synchronization
Company deliveryAddress__name  VARCHAR Company Name, leave empty for individuals
[ADD1] Street address deliveryAddress__addressFirstLine  VARCHAR The street address. For example, 1600 Amphitheatre Pkwy.
[ADD2] Post office box number deliveryAddress__addressSecondLine  VARCHAR The post office box number for PO box addresses. For example, DN7524.
[ADD3] Address extension deliveryAddress__addressThirdLine  VARCHAR An address extension such as an apartment number, C/O or alternative name.
[ADD4] Address extension deliveryAddress__addressFourthLine  VARCHAR Fourth line of the address
Postal Code deliveryAddress__postalCode  VARCHAR The postal code. For example, 94043.
Locality deliveryAddress__city  VARCHAR The locality in which the street address is, and which is in the region. I.e, Mountain View.
Country name deliveryAddress__country  VARCHAR The country name.
Country ISO code deliveryAddress__countryCode  ISO COUNTRY The country. Recommended to be in 2-letter ISO 3166-1 alpha-2 format, for example 'US'.
Is Invoicing deliveryAddress__isInvoicingAddress  BOOL Is address invoicing address ?
Is Delivery deliveryAddress__isDeliveryAddress  BOOL Is address delivery address ?
Latitude deliveryAddress__latitude  DOUBLE [Geocode] Address Latitude
Longitude deliveryAddress__longitude  DOUBLE [Geocode] Address Longitude
[BA] Company invoicingAddress__name  VARCHAR Billing :Company
[BA] [ADD1] Street address invoicingAddress__addressFirstLine  VARCHAR Billing :[ADD1] Street address
[BA] [ADD2] Post office box number invoicingAddress__addressSecondLine  VARCHAR Billing :[ADD2] Post office box number
[BA] [ADD3] Address extension invoicingAddress__addressThirdLine  VARCHAR Billing :[ADD3] Address extension
[BA] Postal Code invoicingAddress__postalCode  VARCHAR Billing :Postal Code
[BA] Locality invoicingAddress__city  VARCHAR Billing :Locality
[BA] Country name invoicingAddress__country  VARCHAR Billing :Country name
[BA] Country ISO code invoicingAddress__countryCode  ISO COUNTRY Billing :Country ISO code
[ADD4] Address extension invoicingAddress__addressFourthLine  VARCHAR Fourth line of the address
Is Invoicing invoicingAddress__isInvoicingAddress  BOOL Is address invoicing address ?
Is Delivery invoicingAddress__isDeliveryAddress  BOOL Is address delivery address ?
Latitude invoicingAddress__latitude  DOUBLE [Geocode] Address Latitude
Longitude invoicingAddress__longitude  DOUBLE [Geocode] Address Longitude
IsArchived isArchived  BOOL IsArchived
Date Created created  DATETIME Object creation date
Date Modified updated  DATETIME Last modification date
Company company  ThirdParty First Company where Contact is Attached
Single Company company_single  ThirdParty Single Company where Contact is Attached
Company ID id@compagnies  >   ThirdParty Company ID
Is Main main@compagnies  >   BOOL Is Main
Is Invoicing invoicing@compagnies  >   BOOL Is Invoicing
Is Dunning dunning@compagnies  >   BOOL Is Dunning

Definition


Canonical Type Product Objects Name Product
Description Sellsy Products Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Type type  VARCHAR Type
Splash Presence presence  BOOL Object presence indicator on remote server
Product Name name  VARCHAR Full product name
Reference reference  VARCHAR Product reference (SKU)
StandardQuantity standardQuantity  DOUBLE StandardQuantity
Short Description description  VARCHAR Product short description
IsNameInDescription isNameInDescription  BOOL IsNameInDescription
UnitId unitId  INT UnitId
CategoryId categoryId  INT CategoryId
AccountingCodeId accountingCodeId  VARCHAR AccountingCodeId
AccountingPurchaseCodeId accountingPurchaseCodeId  VARCHAR AccountingPurchaseCodeId
IsArchived isArchived  BOOL IsArchived
Active isActive  BOOL Product is active
IsDeclined isDeclined  BOOL IsDeclined
ReferencePriceTaxesExc referencePriceTaxesExc  VARCHAR ReferencePriceTaxesExc
ReferencePriceTaxesInc referencePriceTaxesInc  VARCHAR ReferencePriceTaxesInc
IsReferencePriceTaxesFree isReferencePriceTaxesFree  BOOL IsReferencePriceTaxesFree
TaxId taxId  INT TaxId
Currency currency  ISO CURRENCY Currency
Price price  PRICE Product selling price
Wholesale Price price-wholesale  PRICE Product wholesale / cost price

Definition


Canonical Type Invoice Objects Name Invoice
Description Sellsy Invoice API Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Internal Ref. number  VARCHAR Unique internal invoice reference
Splash Presence presence  BOOL Object presence indicator on remote server
Invoice Date date  DATE Official issuing date of the invoice
Payment Due Date dueDate  DATE Date the payment is expected
Currency currency  ISO CURRENCY Currency of the document
Customer Ref. company_reference  VARCHAR Customer-side invoice reference
Subject subject  VARCHAR Subject
Customer Ref. orderReference  VARCHAR Customer-side order reference
Note note  TEXT Note
TotalRawExclTax amounts__totalRawExclTax  DOUBLE Total Amount of the invoice
TotalAfterDiscountExclTax amounts__totalAfterDiscountExclTax  DOUBLE Total Amount of the invoice after discount
TotalPackaging amounts__totalPackaging  DOUBLE Total Packaging of the invoice
TotalShipping amounts__totalShipping  DOUBLE Total Shipping of the invoice
TotalExclTax amounts__totalExclTax  DOUBLE Total Amount of the invoice excluding taxes
TotalInclTax amounts__totalInclTax  DOUBLE Total Amount of the invoice including taxes
TotalRemainingDueInclTax amounts__totalRemainingDueInclTax  DOUBLE Total Remaining Due of the invoice including taxes
TotalPrimesInclTax amounts__totalPrimesInclTax  DOUBLE Total Primes of the invoice including taxes
Customer customer  ThirdParty Customer of the document (order / invoice)
Transaction ID number@payments  >   VARCHAR Reference of the payment transaction
Amount amount@payments  >   DOUBLE Received amount, taxes included
Date paidAt@payments  >   DATE Date the payment was received
Method ID paymentMethodId@payments  >   VARCHAR Sellsy Payment Method Id
Payment Method method@payments  >   VARCHAR Method of the payment
Currency currency@payments  >   ISO CURRENCY Payment Currency Code
Status status@payments  >   VARCHAR Payment status
Note note@payments  >   TEXT Invoice Note
Date Created created  DATETIME Object creation date
IsDeposit isDeposit  BOOL IsDeposit
IsSentToAccounting isSentToAccounting  BOOL IsSentToAccounting
PublicLink publicLink  URL PublicLink
PdfLink pdfLink  URL PdfLink
Status status  VARCHAR Current invoice status
Product SKU reference@rows  >   VARCHAR SKU of the line product
Description description@rows  >   VARCHAR Line description
Unit Price unitAmount@rows  >   PRICE Line unit price
Quantity quantity@rows  >   INT Line quantity
Discount (%) discount@rows  >   DOUBLE Discount applied to the line, in percent
VAT Code taxId@rows  >   VARCHAR Code or name of the applicable VAT rate
Product ID related@rows  >   Product Splash ID of the line product
Id id@rows  >   INT Item ID
Line Type rowType@rows  >   VARCHAR Normalized type of the line

Definition


Canonical Type Webhook Objects Name Webhook
Description Sellsy Webhook API Object
Capabilities Allow Push Created Allow Push Updated Allow Push Deleted

Default Configuration

Default Sync options when you first connect this server.

Imports Pull Created Pull Update Pull Deleted
Exports Push Created Push Updated Push Deleted

Available Fields

Name Identifier Flags Data Format Field Description
Is_enabled is_enabled  BOOL Is_enabled
Type type  VARCHAR Type
Name name  VARCHAR Name
Endpoint endpoint  VARCHAR Endpoint
Channel default_channel  VARCHAR Channel
Id id@configuration  >   VARCHAR Event ID
IsEnabled isEnabled@configuration  >   BOOL IsEnabled
Channel channel@configuration  >   VARCHAR Channel
Created created  DATETIME Created
Updated updated  DATETIME Updated
LastSucceeded lastSucceeded  DATETIME LastSucceeded
LastFailed lastFailed  DATETIME LastFailed