invantive documentation
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

SalesInvoices : Factures de vente Robaws

insert update delete REST

  • Catalogue : Robaws
  • Schéma : SalesInvoices
  • Clés primaires : id
  • Libellé : Factures de vente

Rechercher

Permet de récupérer et de modifier des données à l'aide de insert, update et delete.

Source de l'API

  • Point de terminaison : /api/v2/sales-invoices
  • Opération : get /api/v2/sales-invoices

Caractéristiques de performance

Characteristic Value
Latence moyenne d'accès (ms) 134
Nombre de lignes par minute en mode de balayage complet 26,819
Nombre de lignes de requêtes ponctuelles par minute 933
Nombre d'enregistrements écrits par minute 539

Le résultat peut être mis en cache côté client.

Paramètres

Name Type de données Required Default Documentation
articleId ``
clientId ``
deliveryNoteId ``
fromDate ``
journalId ``
journalName ``
materialId ``
projectId ``
salesOrderId ``
searchText ``
sort ``
subscriptionId ``
toDate ``
type `` Valeurs : INVOICE, CREDIT_NOTE.
updatedFrom ``
withArchived ``
workOrderId ``

Colonnes de table

Les colonnes de la table SalesInvoices sont présentées ci-dessous. Chaque colonne possède un type de données SQL. Une nouvelle valeur non nulle doit être fournie pour chaque colonne requise à tout moment lors de l'insertion et de la mise à jour.

Name Type de données Label Required Marks Documentation
accountancyStatus varchar2 Situation comptable filtres sur la plateforme, modifiables, accountancyStatus
advanceInvoice char Facture anticipée filtres sur la plateforme, modifiables, advanceInvoice
advancePercentage decimal Avance (%) filtres sur la plateforme, modifiables, advancePercentage Le pourcentage d'acompte, exprimé sur une échelle allant de 0 à 100.
archivedAt datetime Archivé à filtres sur la plateforme, modifiables, archivedAt
assignedUserId varchar2 Identifiant utilisateur attribué filtres sur la plateforme, modifiables, assignedUserId
booked char Booked filtres sur la plateforme, modifiables, booked
clientId varchar2 Id du client filtres sur la plateforme, modifiables, clientId
clientReference varchar2 Référence client filtres sur la plateforme, modifiables, clientReference
companyId varchar2 ID de l'entreprise filtres sur la plateforme, modifiables, companyId
contactPersonId varchar2 Identifiant de la personne à contacter filtres sur la plateforme, modifiables, contactPersonId
createdAt datetime Créé le filtres sur la plateforme, modifiables, createdAt
creditedInvoiceId varchar2 Référence de la facture de crédit filtres sur la plateforme, modifiables, creditedInvoiceId Présent uniquement pour les factures de type CREDIT_NOTE.Il s'agit de l'identifiant de la facture qui a été créditée par cet avoir.
creditedTotal decimal Total crédité filtres sur la plateforme, modifiables, creditedTotal Présent uniquement pour les factures de type INVOICE
currency varchar2 Currency filtres sur la plateforme, modifiables, currency
date datetime Date filtres sur la plateforme, modifiables, date
deletedAt datetime Supprimé le filtres sur la plateforme, modifiables, deletedAt
deliveryClientId varchar2 Client ID de livraison filtres sur la plateforme, modifiables, deliveryClientId
deliveryNoteId varchar2 Référence du bon de livraison filtres sur la plateforme, modifiables, deliveryNoteId
documentId varchar2 Document ID filtres sur la plateforme, modifiables, documentId
exchangeRate decimal Taux de Change filtres sur la plateforme, modifiables, exchangeRate
expireDate datetime Vervaldatum filtres sur la plateforme, modifiables, expireDate
extraFields varchar2 Champs supplémentaires writable Le texte JSON de l'objet imbriqué.
finalInvoice char Facture finale filtres sur la plateforme, modifiables, finalInvoice
holdbackItem_calculatedAmount decimal Poste de retenue Montant calculé filtres sur la plateforme, modifiables, holdbackItem.calculatedAmount
holdbackItem_deadline datetime Élément de retenue - Date limite filtres sur la plateforme, modifiables, holdbackItem.deadline
holdbackItem_fixedAmount decimal Poste de retenue – Montant fixe filtres sur la plateforme, modifiables, holdbackItem.fixedAmount
holdbackItem_numberOfDays int32 Période de retenue Nombre de jours filtres sur la plateforme, modifiables, holdbackItem.numberOfDays
holdbackItem_percentage decimal Pourcentage de retenue par article filtres sur la plateforme, modifiables, holdbackItem.percentage
holdbackItem_type varchar2 Type d'élément de retenue filtres sur la plateforme, modifiables, holdbackItem.type
id varchar2 ID filtres sur la plateforme, modifiables, id
introText varchar2 Texte d'introduction filtres sur la plateforme, modifiables, introText Lors de la lecture, présent uniquement si demandé via le paramètre de requête 'include', sinon null.Contenu HTML.Les images intégrées sont résolues en URL selon l'en-tête de requête 'x-robaws-html-image-mode' : TEMPORARY_URL (par défaut) renvoie des URL pré-signées à durée limitée qui ne nécessitent aucune authentification ; PERMANENT_URL renvoie des URL stables qui nécessitent une session authentifiée ; NONE renvoie le HTML stocké, où chaque image est une avec un data-robaws-id et un src vide — conservez cette balise et son data-robaws-id lors de la réécriture du HTML, faute de quoi l'image sera perdue.Toute autre valeur (par ex.BASE64_INLINE) renvoie 400 Bad Request.En écriture, omettez-le ou envoyez null pour conserver le texte actuel ; envoyez une chaîne vide pour le vider.
invoicePeriod_end datetime Fin de la période de facturation filtres sur la plateforme, modifiables, invoicePeriod.end
invoicePeriod_start datetime Début de la période de facturation filtres sur la plateforme, modifiables, invoicePeriod.start
journalId varchar2 Identifiant de la revue filtres sur la plateforme, modifiables, journalId
journalName varchar2 Nom de la revue filtres sur la plateforme, modifiables, journalName Obsolète.Utilisez plutôt companyId et journalId pour créer des factures.
lockedAt datetime Verrouillé à filtres sur la plateforme, modifiables, lockedAt
logicId varchar2 Identifiant logique filtres sur la plateforme, modifiables, logicId
openTotal decimal Total des positions ouvertes filtres sur la plateforme, modifiables, openTotal
originType varchar2 Type d'origine filtres sur la plateforme, modifiables, originType
paidTotal decimal Total versé filtres sur la plateforme, modifiables, paidTotal
paymentConditionId varchar2 Référence des conditions de paiement filtres sur la plateforme, modifiables, paymentConditionId
paymentInstruction varchar2 Instructions de paiement filtres sur la plateforme, modifiables, paymentInstruction
peppolResponseStatus varchar2 Statut de réponse Peppol filtres sur la plateforme, modifiables, peppolResponseStatus
peppolSentDate datetime Date d'envoi Peppol filtres sur la plateforme, modifiables, peppolSentDate
peppolStatus varchar2 Statut Peppol filtres sur la plateforme, modifiables, peppolStatus
poNumber varchar2 Numéro de bon de commande filtres sur la plateforme, modifiables, poNumber
rechnungType varchar2 Type de facture allemande filtres sur la plateforme, modifiables, rechnungType
remark varchar2 Remark filtres sur la plateforme, modifiables, remark
rentalInvoicingPeriodId varchar2 Code de période de facturation des loyers filtres sur la plateforme, modifiables, rentalInvoicingPeriodId
selfBilling char Auto-facturation filtres sur la plateforme, modifiables, selfBilling
selfBillingNumber varchar2 Numéro d'autofacturation filtres sur la plateforme, modifiables, selfBillingNumber
status varchar2 Status filtres sur la plateforme, modifiables, status
statusDetails_color varchar2 Détails de l'état Couleur filtres sur la plateforme, modifiables, statusDetails.color
statusDetails_name varchar2 Détails du statut Nom filtres sur la plateforme, modifiables, statusDetails.name
subscriptionId varchar2 ID d'abonnement filtres sur la plateforme, modifiables, subscriptionId
totalExclVat decimal Totale hors VAT filtres sur la plateforme, modifiables, totalExclVat Total des lignes hors TVA, dans la devise du document (attributes.currency) ; le taux de change n'est pas appliqué.Dans /aggregate, SUM, AVG, MIN et MAX comptent un avoir en négatif ; /query renvoie la valeur telle qu'enregistrée.
totalInclVat decimal Total TTC filtres sur la plateforme, modifiables, totalInclVat Total TVA comprise, dans la devise du document (attributes.currency) ; le taux de change n'est pas appliqué.Dans /aggregate, SUM, AVG, MIN et MAX comptent un avoir en négatif ; /query renvoie la valeur telle qu'enregistrée.
type varchar2 Type filtres sur la plateforme, modifiables, type
updatedAt datetime Mise à jour à filtres sur la plateforme, modifiables, updatedAt
withRespectTo varchar2 En ce qui concerne filtres sur la plateforme, modifiables, withRespectTo

Clés

Key Column Se réfère à Kind Description
SalesInvoices_assignedUserId_txt assignedUserId Users.id Textual La ligne référencée, tant que Robaws la répertorie encore : une ligne supprimée ou purgée n'est plus répertoriée, et un document peut continuer à y faire référence.
SalesInvoices_clientId_txt clientId Clients.id Textual La ligne référencée, tant que Robaws la répertorie encore : une ligne supprimée ou purgée n'est plus répertoriée, et un document peut continuer à y faire référence.
SalesInvoices_companyId_fk companyId Companies.id Key
SalesInvoices_creditedInvoiceId_txt creditedInvoiceId SalesInvoices.id Textual La ligne référencée, tant que Robaws la répertorie encore : une ligne supprimée ou purgée n'est plus répertoriée, et un document peut continuer à y faire référence.
SalesInvoices_deliveryNoteId_fk deliveryNoteId DeliveryNotes.id Key
SalesInvoices_subscriptionId_fk subscriptionId Subscriptions.id Key

Référencée

Exemples de Queries

select inv.logicId
,      inv.date
,      inv.expireDate
,      inv.openTotal
,      cnt.name client_name
from   Robaws.SalesInvoices.SalesInvoices inv
join   Robaws.Clients.Clients cnt
on     cnt.id = inv.clientId
where  inv.openTotal > 0

Notes de Version

Quels ont été les changements apportés à chaque version au niveau des tables, des colonnes, des attributs et des fonctionnalités du chauffeur :