Définition de l'objet
Carte
PipelineItem
Les propriétés d'une fiche « Carte », ses énumérations et ses liaisons avec les autres fiches.
Une fiche « Carte », telle que l'API la lit et l'écrit (PipelineItem dans la référence). Sa liste et sa création : https://staging-api.docage.com/PipelineItems ; une fiche : https://staging-api.docage.com/PipelineItems/{id}. Les propriétés communes à toutes les fiches sont sur la page des définitions des objets.
Ses propriétés
AmountnombreLe montant de la carte. Quand la carte porte le champ réservé
Card_Amount, c'est lui qui fait foi : sa valeur est recopiée ici à chaque enregistrement.AmountInclTaxnombreLecture seuleMontant TTC
ClosedDatedate et heure (UTC)Date de clôture
CompanyIdidentifiantIdentifiant de la société
CreationSubFormIdidentifiantIdentifiant du sous-formulaire de création
Comment le document imprime les lignes que le client a écartées sur l'écran de personnalisation : marquées « Non retenue », rayées, ou non imprimées. Réglé sur le devis, dans les réglages du chiffrage, et écrit par
PUT PipelineItems/{id}/Linescomme le régime de TVA ; suit la révision.DefinitionIdidentifiantIdentifiant du type
DueDatedate et heure (UTC)L'échéance de la carte. Quand la carte porte le champ réservé
Card_DueDate, c'est lui qui fait foi : sa valeur est recopiée ici à chaque enregistrement.DueReminderForDatedate et heure (UTC)Lecture seuleRappel envoyé pour l'échéance du
FailureReasonIdidentifiantMotif d'échec
GlobalDiscountRatenombreLecture seuleRemise globale (%)
HandlerIdidentifiantIdentifiant du responsable
Instancesliste dePipelineItemCartes générées
LastMessageDatedate et heure (UTC)Lecture seuleDate du dernier message
LastMessageExcerpttexteLecture seuleExtrait du dernier message
LastMessageFromCorrespondentoui ou nonLecture seuleDernier message du correspondant
MainContactIdidentifiantIdentifiant de l'interlocuteur principal
MembersToApplyliste dePipelineMemberLes intervenants à appliquer dans la même écriture : la liste remplace la précédente, une liste vide les retire tous, son absence n'y touche pas.
NextOccurrenceIdidentifiantLecture seuleIdentifiant de l'occurrence suivante
Numbertexte, 32 caractères au plusÉcrite par le serveurNuméro
OrderentierLecture seuleRang dans la colonne
ParentPipelineItemIdidentifiantLecture seuleIdentifiant de la carte parente
PipelineIdidentifiantIdentifiant du pipeline
PipelineItemChecklistliste dePipelineItemChecklistItemLecture seulePoints de contrôle
PipelineItemLinesliste dePipelineItemLineLecture seuleLignes
PreviousRevisionIdidentifiantÉcrite par le serveurIdentifiant de la version précédente
PrintTemplateDocumentIdidentifiantModèle d'impression
PriorityDocagePriorityPriorité
ProbabilityentierLa probabilité de gain, de 0 à 100. Le serveur la remplace par celle de l'étape à l'entrée de la carte dans le pipeline et à chaque changement d'étape ; le champ réservé
Card_Probability, s'il est renseigné, l'emporte.RecurrencePipelineItemRecurrenceRépétition de la carte. Inerte si le pipeline ne l'autorise pas (
RecurrenceEnabled).RecurrenceIntervalentierIntervalle de récurrence
Referencetexte, 16 caractères au plusÉcrite par le serveurRéférence
RevisionNumberentierÉcrite par le serveurRévision
Le canal d'entrée de la carte. À ne pas confondre avec l'origine commerciale (« salon », « site web »), propre à chaque métier, qui est un champ de la définition.
StageEnteredDatedate et heure (UTC)Date d'entrée dans l'étape
StageIdidentifiantIdentifiant de l'étape
StatusPipelineStageStatusLe statut de l'étape courante, recopié sur la carte. Il suit l'étape : le serveur l'écrit à chaque changement d'étape, et une modification qui le change est refusée.
TaxAmountnombreLecture seuleMontant de TVA
TextDisplayPricedTextDisplayÉcrite par le serveurOù paraissent l'introduction et les conditions particulières : dans le document, dans l'email. Écrit par
PUT PipelineItems/{id}/Linescomme DeclinedLinePrinting ; suit la révision.Régime de TVA
WeightedAmountnombreMontant pondéré
AddToBoxIdsliste d'identifiantsIdentifiants des classeurs à lier à l'entité
ArchiveRetentionYearsentierDurée d'archivage en années
BoxIdsliste d'identifiantsLecture seuleIdentifiants des classeurs liés à l'entité (lecture seule)
CreationDatedate et heure (UTC)Écrite par le serveurDate de création
Créateur
CreationUserIdidentifiantÉcrite par le serveurIdentifiant du créateur
CultureInfotexteCulture
CustomFieldsliste deFieldLes champs personnalisés de la fiche : ceux de son organisation et ceux de son modèle.
CustomFieldsForInstancesliste deFieldChamps personnalisés pour les entités générées par le modèle
CustomFieldsFromOrganizationliste deFieldChamps personnalisés de l'organisation
CustomFieldsFromTemplateliste deFieldChamps personnalisés du modèle
CustomFieldsUserDataliste deFieldUserDataValeurs des champs personnalisés
DeletionDatedate et heure (UTC)Écrite par le serveurDate de suppression
Auteur de la suppression
DeletionUserIdidentifiantÉcrite par le serveurIdentifiant de l'auteur de la suppression
DynamicInclusionDynamicInclusionSi une inclusion dynamique est définie, l'entité sera incluse dans son parent que si la condition est remplie
EntityStateStateLevelLecture seuleEtat de l'entité
ExternalIdtexte, 128 caractères au plusIdentifiant externe
GeneratedByCampaignIdidentifiantÉcrite par le serveurCampagne ayant généré l'entité
GeneratedByFormIdidentifiantIdentifiant du formulaire ayant généré l'entité
IdidentifiantÉcrite par le serveurIdentifiant
IsArchivedoui ou nonArchivé
IsSystemoui ou nonÉcrite par le serveurEst système
IsTemplateoui ou nonLecture seuleEst un modèle
LanguageLanguageLangue
LastModificationDatedate et heure (UTC)Écrite par le serveurDate de modification
Dernier modificateur
LastModificationUserIdidentifiantÉcrite par le serveurIdentifiant du dernier modificateur
MergeEntitiesliste deMergeEntityObjets participant à la fusion
MergeFieldsliste deMergeFieldChamps de fusion
MustBeArchivedoui ou nonDate de début d'archivage
Nametexte, 255 caractères au plusNom
NotestexteNotes
ParentOrganizationIdidentifiantLecture seuleOrganisation parente
ParentRightsDTOliste deRightDTOLes nouveaux droits de la fiche, à sa création ou à sa mise à jour : la liste REMPLACE ses droits, elle doit donc contenir tous les nouveaux droits. Réservé à qui administre la fiche : pouvoir la modifier ne suffit pas.
RelationDefinitionsForInstancesliste deRelationDefinitionLes relations déclarées sur ce modèle : une extrémité est imposée (le modèle lui-même), et la relation ne vaut que pour ses instances — en plus de celles déclarées au niveau de l'organisation dont une extrémité est du même type. Elles se propagent comme CustomFieldsForInstances : une instance les lit dans RelationDefinitionsFromTemplate.
RelationDefinitionsFromTemplateliste deRelationDefinitionLes relations qu'une instance tient de son modèle. Elles ne sont pas recopiées : elles se relisent sur le modèle à chaque lecture. Ajouter une relation sur un modèle la fait donc apparaître sur toutes ses instances existantes, y compris celles créées avant, comme un champ personnalisé (CustomFieldsFromTemplate).
RemoveFromBoxIdsliste d'identifiantsIdentifiants des classeurs à délier de l'entité
TemplateIdidentifiantIdentifiant de Modèle utilisé
Aucune propriété ne correspond.
Ses énumérations
DeclinedLinePrinting
- 0Imprimée, marquée « Non retenue »
- 1Imprimée, rayée
- 2Non imprimée
DocagePriority
- 0Basse
- 1Normale
- 2Haute
- 3Urgente
PipelineItemRecurrence
- 0Aucune
- 1Quotidienne
- 2Hebdomadaire
- 3Mensuelle
- 4Annuelle
PipelineItemSource
- 0Saisie manuelle
- 1Formulaire
- 2Email
- 3API
- 4Flux
PipelineStageStatus
- 0Nouveau
- 1En cours
- 2En attente
- 3Aboutie
- 4Échouée
- 5Close
VatScheme
- 0TVA normale
- 1Autoliquidation
- 2Exonéré
- 3Hors champ
Ses liaisons
Les fiches auxquelles elle se lie, et le rôle de chacune : ce que LinkedToTypeName et LinkedToId retrouvent dans
une liste (voir Lire des listes).