API docs by Redocly

BillingApi (v1)

Download OpenAPI specification:

Introduction

L'API de facturation fournit des points de terminaison pour la gestion de divers aspects de la facturation. Elle permet des opérations liées aux clients, aux produits, aux devis, aux factures (y compris différents types comme les factures commerciales, les notes de crédit et les factures de prépaiement), aux brouillons de factures, aux abonnements et aux données transactionnelles. L'API comprend également des fonctionnalités pour la gestion des paramètres de facturation, des paramètres d'apparence et de l'audit des chronologies des documents.

Authentication

Voir : Authentification API Inqom

BalanceInvoice

Create balance invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create balance invoice command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreateBalanceInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview balance invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Preview command with VAT legal notice

AccountingFolderId
required
integer <int32>
object (CreateBalanceInvoiceCommandV2)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Create invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreateBalanceInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
AccountingFolderId
required
integer <int32>
object (CreateBalanceInvoiceCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Recreate Pdf

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Responses

CommercialInvoice

Create commercial invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create commercial invoice command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreateCommercialInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
integer or null <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview commercial invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Preview command with VAT legal notice

AccountingFolderId
required
integer <int32>
object (CreateCommercialInvoiceCommandV2)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Create invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreateCommercialInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
integer or null <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
AccountingFolderId
required
integer <int32>
object (CreateCommercialInvoiceCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Recreate Pdf

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Responses

CreditNote

Create a credit note for an invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Reference invoice identifier

Request Body schema:

Create credit note command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreateCreditNoteLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
ShowDeliveryAddress
boolean or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "ShowDeliveryAddress": true,
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Create a credit note without an invoice for a customer with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

customerId
required
integer <int32>

Customer identifier

Request Body schema:

Create credit note command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreateCreditNoteLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
DueDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview credit note with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Reference invoice identifier

Request Body schema:

Create credit note preview command with VAT legal notice

object (CreateCreditNoteCommandV2)

Responses

Request samples

Content type
{
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Preview credit note without an invoice for a customer with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

customerId
required
integer <int32>

Customer identifier

Request Body schema:

Create credit note preview command with VAT legal notice

object (CreateCreditNoteWithoutInvoiceCommandV2)

Responses

Request samples

Content type
{
  • "CreateCreditNoteWithoutInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Create a credit note for an invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>
Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreateCreditNoteLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
ShowDeliveryAddress
boolean or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "ShowDeliveryAddress": true
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Create a credit note without an invoice for a customer Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
customerId
required
integer <int32>
Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreateCreditNoteLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
DueDate
string or null <date-time>
ShowDeliveryAddress
boolean or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>
Request Body schema:
object (CreateCreditNoteCommand)

Responses

Request samples

Content type
{
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Preview credit note without an invoice for a customer Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

customerId
required
integer <int32>

Customer Identifier

Request Body schema:

Command to create the preview

object (CreateCreditNoteWithoutInvoiceCommand)

Responses

Request samples

Content type
{
  • "CreateCreditNoteWithoutInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Recreate Pdf

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Responses

Customer

Get an enterprise by its accounting folder id and customer id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

customerId
required
integer <int32>

Customer Id

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Siren": "string",
  • "LegalName": "string",
  • "VatNumber": "string",
  • "SelectedPeppolAddressingIdentifier": "string"
}

Update a enterprise customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

customerId
required
integer <int32>

Customer Id

Request Body schema:

Customer infos

Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
RowVersion
required
string
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
required
string non-empty
Siren
required
string non-empty
Nic
string or null
LegalName
required
string non-empty
VatNumber
string or null
SelectedPeppolAddressingIdentifier
string or null

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "RowVersion": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "LegalName": "string",
  • "VatNumber": "string",
  • "SelectedPeppolAddressingIdentifier": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Siren": "string",
  • "LegalName": "string",
  • "VatNumber": "string",
  • "SelectedPeppolAddressingIdentifier": "string"
}

Get a foreign enterprise customer by its accounting folder id and customer id.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

customerId
required
integer <int32>

Customer Id

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Registration": "string",
  • "LegalName": "string",
  • "VatNumber": "string"
}

Update a foreign enterprise customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

customerId
required
integer <int32>

Customer Id

Request Body schema:

Customer infos

Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
RowVersion
required
string
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
required
string non-empty
Registration
required
string non-empty
LegalName
required
string non-empty
VatNumber
string or null

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "RowVersion": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "Registration": "string",
  • "LegalName": "string",
  • "VatNumber": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Registration": "string",
  • "LegalName": "string",
  • "VatNumber": "string"
}

Get an individual customer by its accounting folder id and customer id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

customerId
required
integer <int32>

Customer Id

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "FirstName": "string",
  • "LastName": "string"
}

Update a individual customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

customerId
required
integer <int32>

Customer Id

Request Body schema:

Customer infos

Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
RowVersion
required
string
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
required
string non-empty
FirstName
required
string non-empty
LastName
required
string non-empty

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "RowVersion": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "FirstName": "string",
  • "LastName": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "FirstName": "string",
  • "LastName": "string"
}

Get a customer for an accounting folder id and customer id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
customerId
required
integer <int32>

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ]
}

Delete a customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

customerId
required
integer <int32>

Customer Id

Responses

Get a customer's electronic-invoicing eligibility, refreshing it from the ViDA directory when the cached value is stale.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

customerId
required
integer <int32>

Customer Id

Responses

Response samples

Content type
{
  • "Status": "NotConcerned",
  • "ActionRequiredReason": "None",
  • "CheckedAt": "2019-08-24T14:15:22Z"
}

Create a new enterprise customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:
Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
string or null
Siren
required
string non-empty
Nic
string or null
LegalName
required
string non-empty
VatNumber
string or null
SelectedPeppolAddressingIdentifier
string or null

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "LegalName": "string",
  • "VatNumber": "string",
  • "SelectedPeppolAddressingIdentifier": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Siren": "string",
  • "LegalName": "string",
  • "VatNumber": "string",
  • "SelectedPeppolAddressingIdentifier": "string"
}

Create a new foreign enterprise customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:
Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
string or null
Registration
required
string non-empty
LegalName
required
string non-empty
VatNumber
string or null

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "Registration": "string",
  • "LegalName": "string",
  • "VatNumber": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "Registration": "string",
  • "LegalName": "string",
  • "VatNumber": "string"
}

Create a new individual customer

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:
Reference
string or null
UserNotes
string or null
Email
string or null
PhoneNumber
string or null
required
object (Address)
object (Address)
DefaultPaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
ExcludedFromReminders
required
boolean
Array of objects or null (ContactViewModel)
AccountNumberMapping
integer or null <int32>
SubAccountCodeMapping
string or null
FirstName
required
string non-empty
LastName
required
string non-empty

Responses

Request samples

Content type
{
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "Contacts": [
    ],
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "FirstName": "string",
  • "LastName": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "CustomerType": "Enterprise",
  • "Siren": "string",
  • "Nic": "string",
  • "Reference": "string",
  • "UserNotes": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "AccountNumberMapping": 0,
  • "SubAccountCodeMapping": "string",
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "DefaultPaymentTerms": "OnReceipt",
  • "ExcludedFromReminders": true,
  • "RowVersion": "string",
  • "DisplayName": "string",
  • "Contacts": [
    ],
  • "FirstName": "string",
  • "LastName": "string"
}

Customer_GetAccountAvailability

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
accountNumber
integer <int32>
subAccountCode
string

Responses

Response samples

Content type
{
  • "IsAvailable": true,
  • "AssociatedCustomerId": 0
}

Get customer import history

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Responses

Response samples

Content type
[
  • {
    }
]

Customer_ImportIndividualCustomers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema: multipart/form-data
AccountingFolderId
integer <int32>
File
string <binary>

Responses

Response samples

Content type
{
  • "SuccessfulRecords": 0,
  • "FailedRecords": 0,
  • "RecordCount": 0,
  • "ImportSessionId": "8551cc30-3ff0-4efd-b30d-184274eeabc4",
  • "Errors": [
    ]
}

Customer_ImportEnterpriseCustomers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema: multipart/form-data
AccountingFolderId
integer <int32>
File
string <binary>

Responses

Response samples

Content type
{
  • "SuccessfulRecords": 0,
  • "FailedRecords": 0,
  • "RecordCount": 0,
  • "ImportSessionId": "8551cc30-3ff0-4efd-b30d-184274eeabc4",
  • "Errors": [
    ]
}

Customer_ImportForeignEnterpriseCustomers

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema: multipart/form-data
AccountingFolderId
integer <int32>
File
string <binary>

Responses

Response samples

Content type
{
  • "SuccessfulRecords": 0,
  • "FailedRecords": 0,
  • "RecordCount": 0,
  • "ImportSessionId": "8551cc30-3ff0-4efd-b30d-184274eeabc4",
  • "Errors": [
    ]
}

Download individual customers sample file

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
FileType
required
string
Enum: "Csv" "Excel"

Responses

Request samples

Content type
{
  • "FileType": "Csv"
}

Response samples

Content type
"string"

Download enterprises customers sample file

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
FileType
required
string
Enum: "Csv" "Excel"

Responses

Request samples

Content type
{
  • "FileType": "Csv"
}

Response samples

Content type
"string"

Download foreign enterprises customers sample file

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:
FileType
required
string
Enum: "Csv" "Excel"

Responses

Request samples

Content type
{
  • "FileType": "Csv"
}

Response samples

Content type
"string"

Delete customers by session id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

sessionId
required
string <uuid>

Session Id

Responses

CustomerReminderExclusion

Exclude the customer from reminders, or bring it back: the exclusion turns off the reminder signal and the automatic sending of the customer's invoices; a manual reminder can still be sent.

Excluded is required: a body without it is refused with 400, instead of bringing the customer back.

Branch on the error Name, never on its message:

  • Customer_NOTFOUND (404): the customer does not exist, or belongs to another folder;
  • FolderSwitchedToEvoliz (403): the folder has switched to Evoliz.

Any write may answer 409 Entity_OUTDATED.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

customerId
required
integer <int32>

Customer Identifier

Request Body schema:

The new exclusion state of the customer

Excluded
required
boolean

Responses

Request samples

Content type
{
  • "Excluded": true
}

DeliveryNote

Create a delivery note from a quote. The customer and the delivery address come from the quote, and a CustomerId other than the quote's customer is refused; the body carries the delivery date, the lines, the document discount and the free text.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create Delivery Note Command

QuoteId
required
integer <int32>
CustomerId
required
integer <int32>
DeliveryDate
string or null <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
FreeTextField
string or null

Responses

Request samples

Content type
{
  • "QuoteId": 0,
  • "CustomerId": 0,
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "FreeTextField": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "DeliveryNoteNumber": 0,
  • "UserFormattedDeliveryNoteNumber": "string",
  • "Status": "Pending",
  • "QuoteId": 0,
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "DeliveryAddress": {
    },
  • "ProductLines": [
    ],
  • "DocumentDiscount": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "FreeTextField": "string",
  • "PdfUrl": "string"
}

Get delivery note by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

deliveryNoteId
required
integer <int32>

Delivery note Identifier

Responses

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "DeliveryNoteNumber": 0,
  • "UserFormattedDeliveryNoteNumber": "string",
  • "Status": "Pending",
  • "QuoteId": 0,
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "DeliveryAddress": {
    },
  • "ProductLines": [
    ],
  • "DocumentDiscount": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "FreeTextField": "string",
  • "PdfUrl": "string"
}

Get the delivery notes created from a quote

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

quoteId
required
integer <int32>

Quote Identifier

Responses

Response samples

Content type
[
  • {
    }
]

DraftInvoice

Generate a pdf for the draft with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create draft invoice command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
SubscriptionScheduledActionId
integer or null <int32>
QuoteId
integer or null <int32>
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "SubscriptionScheduledActionId": 0,
  • "QuoteId": 0,
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Create draft invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create draft invoice command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
SubscriptionScheduledActionId
integer or null <int32>
QuoteId
integer or null <int32>
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "SubscriptionScheduledActionId": 0,
  • "QuoteId": 0,
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Create a new draft invoice from a quote with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

quoteId
required
integer <int32>

Quote Identifier to convert into a draft invoice

Request Body schema:

Optional VAT legal notice information

AccountingFolderId
required
integer <int32>
QuoteId
required
integer <int32>
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "QuoteId": 0,
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Update draft invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftId
required
integer <int32>

Draft Invoice Identifier

Request Body schema:

Update draft invoice command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
RowVersion
required
string
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "RowVersion": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Get draft invoice by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftId
required
integer <int32>

Responses

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Update draft invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftId
required
integer <int32>
Request Body schema:
CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
RowVersion
required
string

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Delete draft invoice

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftId
required
integer <int32>

Draft Invoice Identifier

Responses

Generate a pdf for the draft Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
SubscriptionScheduledActionId
integer or null <int32>
QuoteId
integer or null <int32>

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "SubscriptionScheduledActionId": 0,
  • "QuoteId": 0
}

Create a new draft invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
DeliveryDate
string or null <date-time>
Array of objects or null (DocumentSectionModel)
ShowDeliveryAddress
boolean or null
RecoveryIndemnityText
string or null
SubscriptionScheduledActionId
integer or null <int32>
QuoteId
integer or null <int32>

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "Sections": [
    ],
  • "ShowDeliveryAddress": true,
  • "RecoveryIndemnityText": "string",
  • "SubscriptionScheduledActionId": 0,
  • "QuoteId": 0
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Create a new draft invoice from a quote Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

quoteId
required
integer <int32>

Quote Identifier to convert into a draft invoice

Responses

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "CustomerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ScheduledActionId": 0,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Get all invoices linked to a draft

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftId
required
integer <int32>

Draft Identifier

Responses

Response samples

Content type
[
  • {
    }
]

DraftQuote

Create draft quote with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create draft quote command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
LatePenaltyText
string or null
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Update draft quote with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftQuoteId
required
integer <int32>

Draft Quote Identifier

Request Body schema:

Update draft quote command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
LatePenaltyText
string or null
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
RowVersion
required
string
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "RowVersion": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Generate a pdf for the draft quote

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create draft quote command

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
LatePenaltyText
string or null
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string"
}

Get draft quote by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftQuoteId
required
integer <int32>

Draft Quote Identifier

Responses

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Update draft quote Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftQuoteId
required
integer <int32>

Draft Quote Identifier

Request Body schema:

Update draft quote command

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
LatePenaltyText
string or null
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
RowVersion
required
string

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Delete draft quote

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftQuoteId
required
integer <int32>

Draft Quote Identifier

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Create a new draft quote Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create draft quote command

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
LatePenaltyText
string or null
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string"
}

Get the quote linked to a draft quote

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

draftQuoteId
required
integer <int32>

Draft Quote Identifier

Responses

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string",
  • "UserFormattedQuoteNumber": "string",
  • "QuoteNumber": 0,
  • "Status": "Pending",
  • "BuyerName": "string",
  • "BuyerEmail": "string",
  • "BuyerType": "Enterprise",
  • "PdfUrl": "string",
  • "EmailSentDate": "2019-08-24T14:15:22Z",
  • "DraftQuoteId": 0
}

EvolizMigration

Get the Evoliz migration status and migration recap of an accounting folder

Hide the simple billing module on isSimpleBillingHidden, never on status == Switched: a switched folder still shows it read-only. The two facts are independent, and composing them is done here rather than left to the caller. stopReason is likewise independent of status: it reports the Evoliz workspace provisioning, so a switched folder can carry one. It means the provisioning is to be resumed, not that the switch is undone.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

Responses

Response samples

Content type
{
  • "Status": "BeforeSwitch",
  • "SwitchDate": "2019-08-24T14:15:22Z",
  • "MigrationRecap": {
    },
  • "StopReason": "string",
  • "IsSimpleBillingHidden": true,
  • "StopDetail": "string",
  • "IsAdvancedBillingComingSoon": true,
  • "PlannedSwitchDate": "2019-08-24"
}

Block the Evoliz migration of an accounting folder so the planned switch does not happen (US #70607).

Idempotent. Refused once the folder has switched: the global read-only guard-rail (US #69463) returns 403 beforehand, and the domain invariant (T-6) refuses it on the direct path. Unblocking is out of process. [UnitOfWork] supplies the transaction the retryable command needs; the repository flushes the write.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

Responses

EvolizTransitionStatus

Get the folder's création/rattachement status for the transition page (null until computed).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting folder id

Responses

Response samples

Content type
{
  • "Outcome": "Creation",
  • "TargetEvolizCompanyId": 0,
  • "TargetEvolizCompanyName": "string",
  • "ComputedAt": "2019-08-24T14:15:22Z",
  • "TargetEvolizCompanyCode": "string"
}

IntermediateInvoice

Create intermediate invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create intermediate invoice command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreateIntermediateInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
Amount
required
number <decimal>
AmountValueType
required
string
Enum: "Amount" "Percent"
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "Amount": 0,
  • "AmountValueType": "Amount",
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview intermediate invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Preview command with VAT legal notice

AccountingFolderId
required
integer <int32>
object (CreateIntermediateInvoiceCommandV2)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Create invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreateIntermediateInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
Amount
required
number <decimal>
AmountValueType
required
string
Enum: "Amount" "Percent"
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "Amount": 0,
  • "AmountValueType": "Amount",
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
AccountingFolderId
required
integer <int32>
object (CreateIntermediateInvoiceCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Recreate Pdf

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Responses

Invoice

Send invoice mail with optional default attachments (from GED bibliothèque) and ad hoc attachments (multipart upload).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema: multipart/form-data
DefaultAttachmentIds
Array of integers <int32> [ items <int32 > ]
AdHocAttachments
Array of strings <binary> [ items <binary > ]
AccountingFolderId
integer <int32>
InvoiceId
integer <int32>
Subject
string
Body
string
To
Array of strings
Cc
Array of strings
Bcc
Array of strings

Responses

Get invoice by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Invoice Identifier

Responses

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Get invoices by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

query Parameters
invoiceIds
Array of integers <int32> [ items <int32 > ]

Invoice Identifiers

Responses

Response samples

Content type
[
  • {
    }
]

Get invoice by book letter id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

bookLetterId
required
integer <int32>

Invoice Identifier

Responses

Response samples

Content type
[
  • {
    }
]

Get invoice computed amounts

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
object (DocumentDiscountCommandModel)
object (DocumentChargeCommandModel)
Array of objects or null (ProductLineForComputationModel)
Array of objects or null (DocumentSectionModel)
DepositAmount
required
number <decimal>
RoundingAmount
required
number <decimal>

Responses

Request samples

Content type
{
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    }
}

Set invoice payments from bank transaction

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
TransactionIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "TransactionIds": [
    ]
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Set invoice payments from lettering

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
IsAutomaticLettering
required
boolean
Array of objects or null (SetInvoicePaymentFromLetteredLineCommand)

Responses

Request samples

Content type
{
  • "IsAutomaticLettering": true,
  • "LetteredLines": [
    ]
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Associate a letter id to current invoice payments

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
invoiceId
required
integer <int32>
query Parameters
letterId
integer <int32>

Responses

Send mail for invoice

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
Subject
string or null
Body
string or null
To
Array of strings or null
Cc
Array of strings or null
Bcc
Array of strings or null

Responses

Request samples

Content type
{
  • "Subject": "string",
  • "Body": "string",
  • "To": [
    ],
  • "Cc": [
    ],
  • "Bcc": [
    ]
}

Get metrics for invoice

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
startDate
string <date-time>
endDate
string <date-time>

Responses

Response samples

Content type
{
  • "InvoicedRevenue": 0,
  • "PaidRevenue": 0,
  • "TotalUnpaidInvoices": 0
}

Update invoices with due date less than current date

Authorizations:
oauth2

Responses

Cancel invoice

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Invoice Identifier

Responses

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Get the latest validated issue date

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Responses

Response samples

Content type
"2019-08-24T14:15:22Z"

Runs the nightly reminder pass of both engines under a lease, and does nothing while another pass holds it. Each engine completes at most once per UTC day; an engine that failed runs again on a replay. FromDate and ToDate only bound the legacy engine, which a bounded call runs regardless of its daily guard.

Authorizations:
oauth2
Request Body schema:
FromDate
string or null <date-time>
ToDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "FromDate": "2019-08-24T14:15:22Z",
  • "ToDate": "2019-08-24T14:15:22Z"
}

InvoiceQuota

Get invoice quota status for an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

Responses

Response samples

Content type
{
  • "IsRestricted": true,
  • "Quota": {
    }
}

LegalNoticeDecision

LegalNoticeDecision_GetLegalNoticeDecision

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
CustomerId
required
integer <int32>
InvoiceDate
string or null <date-time>
Array of objects or null (ProductVatChoiceViewModel)

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "InvoiceDate": "2019-08-24T14:15:22Z",
  • "ProductVatChoices": [
    ]
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "LegalNoticeOptions": [
    ],
  • "DefaultLegalNoticeType": "ExemptionArticle261D4"
}

MeasureUnit

Get all available measure units

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Parameter

Create or Update the billing parameters of the accounting folder

Le corps remplace la totalite des parametres : un champ omis est efface. ReminderConfiguration est la seule exception : absent, il ne touche a rien et le reglage de relance reste celui ecrit par la V1 ; present, il fait foi et remplace la sequence, l'interrupteur maitre et la liste des clients exclus. A l'interieur du bloc, l'interrupteur maitre suit la meme regle : absent, il reste tel quel ; fourni, il remplace la valeur en cours. La sequence est soit vide, soit exactement trois niveaux de rangs distincts, strictement croissants sur leur position par rapport a l'echeance. Chaque niveau exige un objet de mail non vide d'au plus 128 caracteres et un corps non vide, et accepte au plus dix adresses en copie. Activer les relances exige les trois niveaux.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
CommercialName
string or null
required
object (Address)
DefaultCurrencyId
required
integer <int32>
SellerEmail
string or null
SellerPhone
string or null
SellerVatNumber
string or null
DefaultProductType
string or null
Enum: "DeliveryOfGoods" "ServiceDelivery"
Array of objects or null (BankAccountInfoModel)
DefaultPaymentTerms
required
string
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
object (DocumentNumberFormatModel)
object (DocumentNumberFormatModel)
DefaultVatId
integer or null <int32>
DefaultProductCategoryId
integer or null <int32>
LatePenaltyText
required
string non-empty
FreeTextField
string or null
ShareCapital
number or null <decimal>
object (HexColorModel)
Array of objects or null (VatAccountPerRateModel)
Array of objects or null (AccountByProductCategoryModel)
IsSuffixRuleEnabled
boolean or null
Array of objects or null (VatSuffixRuleModel)
RowVersion
string or null
object (ReminderConfigurationModel)

Responses

Request samples

Content type
{
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "DefaultCurrencyId": 0,
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "SellerVatNumber": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "DefaultVatId": 0,
  • "DefaultProductCategoryId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ShareCapital": 0,
  • "DefaultDocumentPrimaryColor": {
    },
  • "VatAccountPerRates": [
    ],
  • "AccountsByProductCategory": [
    ],
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "RowVersion": "string",
  • "ReminderConfiguration": {
    }
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalInformation": {
    },
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "Currency": {
    },
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "LogoUrl": "string",
  • "DefaultVatRate": {
    },
  • "DefaultProductCategory": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DefaultDocumentPrimaryColor": "string",
  • "EmailReminder": {
    },
  • "ReminderConfiguration": {
    },
  • "VatAccountPerRates": [
    ],
  • "IsVatMappingInitialized": true,
  • "AccountsByProductCategory": [
    ],
  • "IsSubAccount7GenerationAvailable": true,
  • "IsAdvancedRemindersAvailable": true,
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "ParameterExist": true,
  • "IsProvisionedInEvoliz": true,
  • "RowVersion": "string",
  • "RecoveryIndemnityText": "string"
}

Get the billing parameters of the accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Id

Responses

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalInformation": {
    },
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "Currency": {
    },
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "LogoUrl": "string",
  • "DefaultVatRate": {
    },
  • "DefaultProductCategory": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DefaultDocumentPrimaryColor": "string",
  • "EmailReminder": {
    },
  • "ReminderConfiguration": {
    },
  • "VatAccountPerRates": [
    ],
  • "IsVatMappingInitialized": true,
  • "AccountsByProductCategory": [
    ],
  • "IsSubAccount7GenerationAvailable": true,
  • "IsAdvancedRemindersAvailable": true,
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "ParameterExist": true,
  • "IsProvisionedInEvoliz": true,
  • "RowVersion": "string",
  • "RecoveryIndemnityText": "string"
}

Create or Update the billing parameters of the accounting folder

Le corps remplace la totalité des paramètres : un champ omis est effacé. EmailReminder est la seule exception : absent, il coupe les relances sans rien effacer — le délai, le corps, le moment, la séquence et la liste des clients exclus restent en place — et, n'exprimant aucune liste, il ne réconcilie pas les exclusions. Présent, il fait foi et remplace le réglage ; son Enabled pilote aussi l'interrupteur maître de la séquence quand le dossier en porte une. Une liste d'exclusions vide reste une dés-exclusion explicite.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
CommercialName
string or null
required
object (Address)
DefaultCurrencyId
required
integer <int32>
SellerEmail
string or null
SellerPhone
string or null
SellerVatNumber
string or null
DefaultProductType
string or null
Enum: "DeliveryOfGoods" "ServiceDelivery"
Array of objects or null (BankAccountInfoModel)
DefaultPaymentTerms
required
string
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
object (DocumentNumberFormatModel)
object (DocumentNumberFormatModel)
DefaultVatId
integer or null <int32>
DefaultProductCategoryId
integer or null <int32>
LatePenaltyText
required
string non-empty
FreeTextField
string or null
ShareCapital
number or null <decimal>
object (HexColorModel)
Array of objects or null (VatAccountPerRateModel)
Array of objects or null (AccountByProductCategoryModel)
IsSuffixRuleEnabled
boolean or null
Array of objects or null (VatSuffixRuleModel)
RowVersion
string or null
object (EmailReminderModel)

Responses

Request samples

Content type
{
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "DefaultCurrencyId": 0,
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "SellerVatNumber": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "DefaultVatId": 0,
  • "DefaultProductCategoryId": 0,
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "ShareCapital": 0,
  • "DefaultDocumentPrimaryColor": {
    },
  • "VatAccountPerRates": [
    ],
  • "AccountsByProductCategory": [
    ],
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "RowVersion": "string",
  • "EmailReminder": {
    }
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalInformation": {
    },
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "Currency": {
    },
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "LogoUrl": "string",
  • "DefaultVatRate": {
    },
  • "DefaultProductCategory": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DefaultDocumentPrimaryColor": "string",
  • "EmailReminder": {
    },
  • "ReminderConfiguration": {
    },
  • "VatAccountPerRates": [
    ],
  • "IsVatMappingInitialized": true,
  • "AccountsByProductCategory": [
    ],
  • "IsSubAccount7GenerationAvailable": true,
  • "IsAdvancedRemindersAvailable": true,
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "ParameterExist": true,
  • "IsProvisionedInEvoliz": true,
  • "RowVersion": "string",
  • "RecoveryIndemnityText": "string"
}

Re-synchronizes one VAT rate's 44x account from the chart of accounts.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
vatRateId
required
integer <int32>
Request Body schema:
RowVersion
string or null

Responses

Request samples

Content type
{
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalInformation": {
    },
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "Currency": {
    },
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "LogoUrl": "string",
  • "DefaultVatRate": {
    },
  • "DefaultProductCategory": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DefaultDocumentPrimaryColor": "string",
  • "EmailReminder": {
    },
  • "ReminderConfiguration": {
    },
  • "VatAccountPerRates": [
    ],
  • "IsVatMappingInitialized": true,
  • "AccountsByProductCategory": [
    ],
  • "IsSubAccount7GenerationAvailable": true,
  • "IsAdvancedRemindersAvailable": true,
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "ParameterExist": true,
  • "IsProvisionedInEvoliz": true,
  • "RowVersion": "string",
  • "RecoveryIndemnityText": "string"
}

Re-synchronizes every VAT rate's 44x account from the chart of accounts.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
RowVersion
string or null

Responses

Request samples

Content type
{
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "AccountingFolderId": 0,
  • "LegalInformation": {
    },
  • "CommercialName": "string",
  • "HeadquarterAddress": {
    },
  • "SellerEmail": "string",
  • "SellerPhone": "string",
  • "DefaultProductType": "DeliveryOfGoods",
  • "Currency": {
    },
  • "BankAccountInfo": [
    ],
  • "DefaultPaymentTerms": "OnReceipt",
  • "InvoiceNumberFormat": {
    },
  • "QuotationNumberFormat": {
    },
  • "LogoUrl": "string",
  • "DefaultVatRate": {
    },
  • "DefaultProductCategory": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DefaultDocumentPrimaryColor": "string",
  • "EmailReminder": {
    },
  • "ReminderConfiguration": {
    },
  • "VatAccountPerRates": [
    ],
  • "IsVatMappingInitialized": true,
  • "AccountsByProductCategory": [
    ],
  • "IsSubAccount7GenerationAvailable": true,
  • "IsAdvancedRemindersAvailable": true,
  • "IsSuffixRuleEnabled": true,
  • "SuffixRules": [
    ],
  • "ParameterExist": true,
  • "IsProvisionedInEvoliz": true,
  • "RowVersion": "string",
  • "RecoveryIndemnityText": "string"
}

PrePaymentInvoice

Create pre-payment invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create pre-payment invoice command with VAT legal notice

IssueDate
required
string <date-time>
Array of objects or null (CreatePrePaymentInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
Amount
required
number <decimal>
AmountValueType
required
string
Enum: "Amount" "Percent"
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "Amount": 0,
  • "AmountValueType": "Amount",
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview pre-payment invoice with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Preview command with VAT legal notice

AccountingFolderId
required
integer <int32>
object (CreatePrePaymentInvoiceCommandV2)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Create invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
IssueDate
required
string <date-time>
Array of objects or null (CreatePrePaymentInvoiceLineCommand)
FreeTextField
string or null
Array of objects or null (DocumentSectionModel)
object (DocumentDiscountCommandModel)
CustomerId
required
integer <int32>
PublicTenderIdentifier
string or null
BankAccountInfoIds
Array of integers or null <int32> [ items <int32 > ]
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
DueDate
required
string <date-time>
DeliveryDate
string or null <date-time>
ShowDeliveryAddress
boolean or null
LatePenaltyText
string or null
PaymentMeanId
integer or null <int32>
DraftInvoiceId
required
integer <int32>
PreviousInvoiceId
integer or null <int32>
SubscriptionScheduledActionId
integer or null <int32>
Amount
required
number <decimal>
AmountValueType
required
string
Enum: "Amount" "Percent"
DiscountConditionsFreeTextField
required
string non-empty
RecoveryIndemnityText
string or null

Responses

Request samples

Content type
{
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "InvoiceLineItems": [
    ],
  • "FreeTextField": "string",
  • "Sections": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "CustomerId": 0,
  • "PublicTenderIdentifier": "string",
  • "BankAccountInfoIds": [
    ],
  • "PaymentTerms": "OnReceipt",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ShowDeliveryAddress": true,
  • "LatePenaltyText": "string",
  • "PaymentMeanId": 0,
  • "DraftInvoiceId": 0,
  • "PreviousInvoiceId": 0,
  • "SubscriptionScheduledActionId": 0,
  • "Amount": 0,
  • "AmountValueType": "Amount",
  • "DiscountConditionsFreeTextField": "string",
  • "RecoveryIndemnityText": "string"
}

Response samples

Content type
{
  • "DocumentDiscounts": [
    ],
  • "DocumentCharges": [
    ],
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "VatTotalAmounts": [
    ],
  • "DepositAmount": 0,
  • "RoundingAmount": 0,
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "InvoiceNumber": 0,
  • "UserFormattedInvoiceNumber": "string",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "DeliveryDate": "2019-08-24T14:15:22Z",
  • "ReminderSentDate": "2019-08-24T14:15:22Z",
  • "InvoiceType": "None",
  • "InvoiceSeller": {
    },
  • "InvoiceBuyer": {
    },
  • "PaymentInstructions": {
    },
  • "InvoicePayments": {
    },
  • "LinkedCreditNotes": [
    ],
  • "ElectronicInvoiceEligibility": {
    },
  • "PdfUrl": "string",
  • "FreeTextField": "string",
  • "Status": "ToBeCollected",
  • "PaymentReference": "string",
  • "AccountingDocumentId": 0,
  • "InvoiceReferences": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "ScheduledActionId": 0,
  • "IsCancellable": true,
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "DraftId": 0,
  • "HasDiscountConditions": true,
  • "ShowDeliveryAddress": true,
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStateReasonCode": "NON_TRANSMISE",
  • "ViDAStatusDetails": "string",
  • "ElectronicTransmissionStatus": "None"
}

Preview invoice Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
AccountingFolderId
required
integer <int32>
object (CreatePrePaymentInvoiceCommand)

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "CreateInvoiceCommand": {
    }
}

Response samples

Content type
"string"

Recreate Pdf

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Responses

Product

Get products by ids

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
productIds
Array of integers <int32> [ items <int32 > ]

Responses

Response samples

Content type
[
  • {
    }
]

Create a new product

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:
Name
required
string non-empty
ProductType
required
string
Enum: "DeliveryOfGoods" "ServiceDelivery"
Description
string or null
UnitId
required
integer <int32>
UnitPriceExclTax
required
number <decimal>
PurchasePriceExclTax
number or null <decimal>
VatId
required
integer <int32>
ProductCategoryId
required
integer <int32>
Reference
string or null

Responses

Request samples

Content type
{
  • "Name": "string",
  • "ProductType": "DeliveryOfGoods",
  • "Description": "string",
  • "UnitId": 0,
  • "UnitPriceExclTax": 0,
  • "PurchasePriceExclTax": 0,
  • "VatId": 0,
  • "ProductCategoryId": 0,
  • "Reference": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "ProductType": "DeliveryOfGoods",
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "Description": "string",
  • "UnitPriceExclTax": 0,
  • "UnitPriceInclTax": 0,
  • "PurchasePriceExclTax": 0,
  • "GrossMarginExclTax": 0,
  • "MarginRateOnPurchasePrice": 0,
  • "MarginRateOnSalePrice": 0,
  • "MeasureUnit": {
    },
  • "Currency": {
    },
  • "VatRate": {
    },
  • "ProductCategory": {
    },
  • "Reference": "string",
  • "RowVersion": "string"
}

Search products by name or reference

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Search Query

PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 10
Name
string or null
Reference
string or null
SearchText
string or null
SortColumn
required
string
Enum: "Name" "Reference" "UnitPriceExclTax" "MeasureUnit" "Vat"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 10,
  • "Name": "string",
  • "Reference": "string",
  • "SearchText": "string",
  • "SortColumn": "Name",
  • "SortDirection": "Ascending"
}

Response samples

Content type
{
  • "Items": [
    ],
  • "PageNumber": 1,
  • "PageSize": 1,
  • "TotalCount": 1,
  • "PageCount": 0,
  • "HasPreviousPage": false,
  • "HasNextPage": false
}

Update a product

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

productId
required
integer <int32>

Product Identifier

Request Body schema:
Name
required
string non-empty
ProductType
required
string
Enum: "DeliveryOfGoods" "ServiceDelivery"
Description
string or null
UnitId
required
integer <int32>
UnitPriceExclTax
required
number <decimal>
PurchasePriceExclTax
number or null <decimal>
VatId
required
integer <int32>
ProductCategoryId
required
integer <int32>
Reference
string or null
RowVersion
required
string

Responses

Request samples

Content type
{
  • "Name": "string",
  • "ProductType": "DeliveryOfGoods",
  • "Description": "string",
  • "UnitId": 0,
  • "UnitPriceExclTax": 0,
  • "PurchasePriceExclTax": 0,
  • "VatId": 0,
  • "ProductCategoryId": 0,
  • "Reference": "string",
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "ProductType": "DeliveryOfGoods",
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "Description": "string",
  • "UnitPriceExclTax": 0,
  • "UnitPriceInclTax": 0,
  • "PurchasePriceExclTax": 0,
  • "GrossMarginExclTax": 0,
  • "MarginRateOnPurchasePrice": 0,
  • "MarginRateOnSalePrice": 0,
  • "MeasureUnit": {
    },
  • "Currency": {
    },
  • "VatRate": {
    },
  • "ProductCategory": {
    },
  • "Reference": "string",
  • "RowVersion": "string"
}

Delete a product

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

productId
required
integer <int32>

Responses

Get product import history

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Responses

Response samples

Content type
[
  • {
    }
]

Import products

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema: multipart/form-data
AccountingFolderId
integer <int32>
File
string <binary>

Responses

Response samples

Content type
{
  • "SuccessfulRecords": 0,
  • "FailedRecords": 0,
  • "RecordCount": 0,
  • "ImportSessionId": "8551cc30-3ff0-4efd-b30d-184274eeabc4",
  • "Errors": [
    ]
}

Download products sample file

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
FileType
required
string
Enum: "Csv" "Excel"

Responses

Request samples

Content type
{
  • "FileType": "Csv"
}

Response samples

Content type
"string"

Delete products by import session id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

importSessionId
required
string <uuid>

Import Session Identifier

Responses

ProductCategory

Get all available product categories (backward compatibility - no folder filter)

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]

Get all available product categories for an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

query Parameters
with-usage
boolean
Default: false

Include product usage count for each category

Responses

Response samples

Content type
[
  • {
    }
]

Create a new product category

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create product category command

AccountNumber
required
integer <int32>
Label
string or null
SubAccountCode
string or null

Responses

Request samples

Content type
{
  • "AccountNumber": 0,
  • "Label": "string",
  • "SubAccountCode": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "Label": "string",
  • "PcgAccountNumber": 0,
  • "AccountNumber": 0,
  • "SubAccountCode": "string",
  • "IsSystemCategory": true,
  • "UsageCount": 0
}

Update an existing product category

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

productCategoryId
required
integer <int32>

Product Category Identifier

Request Body schema:

Update product category command

Label
string or null
AccountNumber
required
integer <int32>
SubAccountCode
string or null

Responses

Request samples

Content type
{
  • "Label": "string",
  • "AccountNumber": 0,
  • "SubAccountCode": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "Label": "string",
  • "PcgAccountNumber": 0,
  • "AccountNumber": 0,
  • "SubAccountCode": "string",
  • "IsSystemCategory": true,
  • "UsageCount": 0
}

Delete a product category

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

productCategoryId
required
integer <int32>

Product Category Identifier

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Quote

Create a new quote with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:

Create Quote Command with VAT legal notice

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
PreviousQuoteId
integer or null <int32>
DraftQuoteId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "PreviousQuoteId": 0,
  • "DraftQuoteId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string",
  • "UserFormattedQuoteNumber": "string",
  • "QuoteNumber": 0,
  • "Status": "Pending",
  • "BuyerName": "string",
  • "BuyerEmail": "string",
  • "BuyerType": "Enterprise",
  • "PdfUrl": "string",
  • "EmailSentDate": "2019-08-24T14:15:22Z",
  • "DraftQuoteId": 0
}

Send quote mail with optional default attachments (from GED bibliothèque) and ad hoc attachments (multipart upload).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
quoteId
required
integer <int32>
Request Body schema: multipart/form-data
DefaultAttachmentIds
Array of integers <int32> [ items <int32 > ]
AdHocAttachments
Array of strings <binary> [ items <binary > ]
AccountingFolderId
integer <int32>
QuoteId
integer <int32>
Subject
string
Body
string
To
Array of strings
Cc
Array of strings
Bcc
Array of strings

Responses

Get quote by Id

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

quoteId
required
integer <int32>

Responses

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string",
  • "UserFormattedQuoteNumber": "string",
  • "QuoteNumber": 0,
  • "Status": "Pending",
  • "BuyerName": "string",
  • "BuyerEmail": "string",
  • "BuyerType": "Enterprise",
  • "PdfUrl": "string",
  • "EmailSentDate": "2019-08-24T14:15:22Z",
  • "DraftQuoteId": 0
}

Create a new quote Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

The accounting folder id

Request Body schema:

Create Quote Command

CustomerId
required
integer <int32>
IssueDate
required
string <date-time>
DueDate
required
string <date-time>
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
FreeTextField
string or null
HasDiscountConditions
required
boolean
DiscountConditionsFreeTextField
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
PreviousQuoteId
integer or null <int32>
DraftQuoteId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "FreeTextField": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "PreviousQuoteId": 0,
  • "DraftQuoteId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string",
  • "UserFormattedQuoteNumber": "string",
  • "QuoteNumber": 0,
  • "Status": "Pending",
  • "BuyerName": "string",
  • "BuyerEmail": "string",
  • "BuyerType": "Enterprise",
  • "PdfUrl": "string",
  • "EmailSentDate": "2019-08-24T14:15:22Z",
  • "DraftQuoteId": 0
}

Quote_UpdateStatus

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
AccountingFolderId
required
integer <int32>
QuoteId
required
integer <int32>
NewStatus
required
string
Enum: "Pending" "Approved" "Rejected" "Expired" "Archived"

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "QuoteId": 0,
  • "NewStatus": "Pending"
}

Response samples

Content type
{
  • "ProductLines": [
    ],
  • "Sections": [
    ],
  • "SectionSubtotals": [
    ],
  • "DocumentDiscount": {
    },
  • "DocumentCharge": {
    },
  • "TotalLinePriceExclTax": 0,
  • "TotalDocumentVatAmount": 0,
  • "TotalDocumentPayableAmount": 0,
  • "TotalDocumentPriceExclTax": 0,
  • "TotalDocumentInclTax": 0,
  • "TotalDocumentDiscountsAmount": 0,
  • "TotalDocumentChargesAmount": 0,
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "BuyerId": 0,
  • "DueDate": "2019-08-24T14:15:22Z",
  • "IssueDate": "2019-08-24T14:15:22Z",
  • "BankAccount": {
    },
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "GroupingId": "25a5bfed-14e9-429b-953f-de0ea952b174",
  • "RowVersion": "string",
  • "HasDiscountConditions": true,
  • "DiscountConditionsFreeTextField": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RecoveryIndemnityText": "string",
  • "UserFormattedQuoteNumber": "string",
  • "QuoteNumber": 0,
  • "Status": "Pending",
  • "BuyerName": "string",
  • "BuyerEmail": "string",
  • "BuyerType": "Enterprise",
  • "PdfUrl": "string",
  • "EmailSentDate": "2019-08-24T14:15:22Z",
  • "DraftQuoteId": 0
}

Send mail for quote

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
quoteId
required
integer <int32>
Request Body schema:
Subject
string or null
Body
string or null
To
Array of strings or null
Cc
Array of strings or null
Bcc
Array of strings or null

Responses

Request samples

Content type
{
  • "Subject": "string",
  • "Body": "string",
  • "To": [
    ],
  • "Cc": [
    ],
  • "Bcc": [
    ]
}

Quote_CheckAndUpdateExpiredQuoteStatus

Authorizations:
oauth2

Responses

ReminderPanel

Get the reminder panel of an invoice: the invoice, its customer, the customer's last reminder, the proposed level, the levels of the sequence rendered for this invoice with their recipients, and the allowed actions.

A field that is absent or null in the response means "none": treat both the same way. Dates are UTC, even when they are written without a Z suffix. Enumerations are written by name.

  • Invoice: RemainingAmountInclTax is the remaining amount due including tax, payments and credit notes deducted, the one the reminder signal uses.
  • LastReminder: the last reminder sent to the customer, whatever the invoice, not the last reminder of this invoice served by the search; absent when the customer has never been reminded. Origin is ManualSend, AutomaticSend or LegacyMigration (a reminder taken over from the former engine).
  • ProposedRank: the rank of the level to propose by default.
  • Levels: never empty; each level carries its subject and body already rendered for this invoice, and its Recipients: those the mail would be sent to at this level, the customer's contacts plus the level's copies, without duplicates. They can be edited before sending. To may be empty, and sending is then refused.
  • PdfSizeInBytes: the size of the invoice PDF; absent when the PDF is missing or its file is not found.
  • ReminderEngineEnabled: true when the folder's reminder sequence is on and the folder has switched to the new reminder engine.
  • CanSend: sending a reminder is allowed; false on a folder switched to Evoliz. It does not depend on the customer's exclusion: an excluded customer can still be reminded manually.
  • CanSetAside, CanExclude: setting the signal aside and excluding the customer are allowed; both are false on a folder switched to Evoliz.
  • CanReactivateEngine: true when the reminder sequence is off, the folder has switched to the new reminder engine and it has not switched to Evoliz; it drives the reactivation banner.

On a folder still served by the former reminder engine, the panel signals nothing, as the invoice search does: ProposedRank is 1, ReminderEngineEnabled and CanReactivateEngine are false. CanSetAside stays true there, but a set-aside recorded on such a folder only takes effect once it switches to the new engine: the former engine does not read it, and the switch is final.

On a folder switched to Evoliz, reading is still served, but sending, setting aside and excluding are refused with 403 FolderSwitchedToEvoliz. CanSend, CanSetAside and CanExclude only reflect that switch: on a folder still migrating to Evoliz, the write can be refused with 403 EvolizFolderWithoutBillingSetup while they are true.

Branch on the error Name, never on its message:

  • Invoice_NOT_FOUND (400): the invoice does not exist in the folder or, for an Employee, belongs to a colleague;
  • SendReminderInvoicePaid (417): the invoice has no remaining amount due, which is also the case of a cancelled invoice;
  • SendReminderCreditNoteNotAllowed (417): a credit note cannot be reminded;
  • Customer_NOTFOUND (404): the invoice is attached to no customer.
Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

invoiceId
required
integer <int32>

Invoice Identifier

Responses

Response samples

Content type
{
  • "Invoice": {
    },
  • "Customer": {
    },
  • "LastReminder": {
    },
  • "ProposedRank": 0,
  • "Levels": [
    ],
  • "PdfSizeInBytes": 0,
  • "ReminderEngineEnabled": true,
  • "CanSend": true,
  • "CanSetAside": true,
  • "CanExclude": true,
  • "CanReactivateEngine": true
}

SentReminder

Send the reminder of an invoice at the given level of the folder's sequence, with the invoice PDF attached. Recipients, subject and body are computed server-side from the invoice customer and the level, unless provided.

Subject, Body and Recipients are optional and independent: they carry the text and recipients edited in the reminder panel, each one provided replaces the server's, and each one absent is computed server-side as above.

  • Subject and Body are sent as received, without resolving variables: a {{…}} typed by hand is sent as is.
  • Recipients replaces all the computed recipients, the level's copies included. Addresses are trimmed and empty entries ignored; an address found in several fields, case ignored, is kept once in the most visible one, To then Cc then Bcc. Duplicates are merged, never refused.
  • A folder with no saved level sends from the standard sequence, the one the reminder panel shows.

Branch on the error Name, never on its message:

  • SendReminderInvoicePaid (417): the invoice has no remaining amount due, which is the case of a cancelled invoice settled by its credit note;
  • SendReminderCreditNoteNotAllowed (417): a credit note cannot be reminded;
  • SendReminderLevelNotFound (417): the requested rank is outside 1 to 3;
  • RecipientsRequired (417): no main recipient;
  • RecipientContainsSeparator (417): an edited address contains ;;
  • TotalSizeExceeded (417): the attachments, invoice PDF included, exceed 10 MB in total;
  • Invoice_NOT_FOUND (400): the invoice does not exist in the folder or, for an Employee, belongs to a colleague;
  • Customer_NOTFOUND (404): the invoice is attached to no customer;
  • Subject_EMPTY, Body_EMPTY (400): the subject or the body of the mail is empty;
  • Subject_LENGTH, Body_LENGTH (400): the edited subject exceeds 998 characters, or the edited body 4000;
  • AddressTo_INVALID, AddressCc_INVALID, AddressBcc_INVALID (400): an address of that field is not a valid email address;
  • FolderSwitchedToEvoliz (403): the folder has switched to Evoliz.

These refusals carry their code in ErrorCode instead of Name:

  • INVOICE_IS_CANCELLED (422): the invoice is cancelled and still has an amount due;
  • EMPTY_PDF_URL (422): the invoice has no PDF;
  • INVOICE_DOWNLOAD_ERROR (422): the invoice PDF file is not found;
  • EMAIL_SEND_FAILED (422): the mail service did not accept the mail, and no reminder is recorded.

Any write may answer 409 Entity_OUTDATED. Two simultaneous sends of the same invoice may both mail the customer, the second one answering 409 Entity_OUTDATED with no reminder recorded.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

The invoice to remind, the rank of the level to send, and optionally the edited subject, body and recipients

InvoiceId
required
integer <int32>
Rank
required
integer <int32>
Subject
string or null
Body
string or null
object (ReminderMailRecipients)

Responses

Request samples

Content type
{
  • "InvoiceId": 0,
  • "Rank": 0,
  • "Subject": "string",
  • "Body": "string",
  • "Recipients": {
    }
}

SetAsideReminder

Set aside the reminder signal of each given invoice, with a reason: one record per invoice, and no mail sent. The request is all or nothing: an unknown or cancelled invoice refuses it whole.

The reminder panel sets a single invoice aside: InvoiceIds then carries its only identifier. Reason is AlreadyPaid or TooEarly, written by name. An unknown name is refused with 400 when the body is read, without SetAsideReasonNotSupported.

Branch on the error Name, never on its message:

  • SetAsideInvoicesRequired (417): no invoice given;
  • SetAsideInvoiceCancelled (417): one of the invoices is cancelled;
  • SetAsideReasonNotSupported (417): the reason is not supported;
  • Invoice_NOT_FOUND (400): one of the invoices does not exist in the folder;
  • FolderSwitchedToEvoliz (403): the folder has switched to Evoliz.

Any write may answer 409 Entity_OUTDATED.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

The invoices to set aside, and the reason

InvoiceIds
Array of integers or null <int32> [ items <int32 > ]
Reason
required
string
Enum: "AlreadyPaid" "TooEarly"

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ],
  • "Reason": "AlreadyPaid"
}

Subscription

Create subscription with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Create subscription command with VAT legal notice

Name
string or null
object (EndSubscriptionModel)
object (SubscriptionRecurrenceModel)
FinalizationMode
required
string
Enum: "Draft" "Invoice" "InvoiceAndSendMail"
object (SubscriptionMailConfigurationModel)
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
ShowDeliveryAddress
boolean or null
CustomerIds
Array of integers or null <int32> [ items <int32 > ]
StartDate
required
string <date-time>
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters
DefaultAttachmentIds
Array of integers or null <int32> [ items <int32 > ]
CustomAttachmentIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "Name": "string",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "FinalizationMode": "Draft",
  • "MailConfiguration": {
    },
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "ShowDeliveryAddress": true,
  • "CustomerIds": [
    ],
  • "StartDate": "2019-08-24T14:15:22Z",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "DefaultAttachmentIds": [
    ],
  • "CustomAttachmentIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Update subscription with VAT legal notice support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

subscriptionId
required
integer <int32>

Subscription Identifier

Request Body schema:

Update subscription command with VAT legal notice

Name
string or null
object (EndSubscriptionModel)
object (SubscriptionRecurrenceModel)
FinalizationMode
required
string
Enum: "Draft" "Invoice" "InvoiceAndSendMail"
object (SubscriptionMailConfigurationModel)
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
ShowDeliveryAddress
boolean or null
RowVersion
required
string
VatLegalNoticeType
string or null
Enum: "ExemptionArticle261D4" "ExemptionArticle262I" "ExemptionArticle262TerI" "ExemptionArticle2591" "ExemptionArticle259B" "BaseExemption" "CustomMention" "VatIssuedInvoices" "ReverseCharge" "NotSubject"
VatLegalNoticeText
string or null <= 500 characters

Responses

Request samples

Content type
{
  • "Name": "string",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "FinalizationMode": "Draft",
  • "MailConfiguration": {
    },
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "ShowDeliveryAddress": true,
  • "RowVersion": "string",
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "CreateDate": "2019-08-24T14:15:22Z",
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "FinalizationMode": "Draft",
  • "Status": "Active",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "Template": {
    },
  • "SubscriptionEmailConfig": {
    },
  • "ScheduledActions": [
    ],
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RowVersion": "string"
}

Upload a custom mail attachment for recurring subscriptions. The returned id is meant to be passed in CreateSubscriptionCommandV2.CustomAttachmentIds.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "FileName": "string",
  • "FileSize": 0,
  • "MimeType": "string"
}

Replace the mail attachments of an existing subscription with the desired set (default library templates + previously-uploaded custom attachments).

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

subscriptionId
required
integer <int32>

Subscription Identifier

Request Body schema:

Desired default template ids and custom attachment ids

AccountingFolderId
required
integer <int32>
SubscriptionId
required
integer <int32>
DefaultAttachmentIds
Array of integers or null <int32> [ items <int32 > ]
CustomAttachmentIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "AccountingFolderId": 0,
  • "SubscriptionId": 0,
  • "DefaultAttachmentIds": [
    ],
  • "CustomAttachmentIds": [
    ]
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "CreateDate": "2019-08-24T14:15:22Z",
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "FinalizationMode": "Draft",
  • "Status": "Active",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "Template": {
    },
  • "SubscriptionEmailConfig": {
    },
  • "ScheduledActions": [
    ],
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RowVersion": "string"
}

Subscription_GetSubscription

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
subscriptionId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "CreateDate": "2019-08-24T14:15:22Z",
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "FinalizationMode": "Draft",
  • "Status": "Active",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "Template": {
    },
  • "SubscriptionEmailConfig": {
    },
  • "ScheduledActions": [
    ],
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RowVersion": "string",
  • "FinancialSummary": {
    },
  • "Invoices": [
    ],
  • "DefaultAttachmentIds": [
    ],
  • "CustomAttachments": [
    ]
}

Subscription_UpdateSubscription Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
subscriptionId
required
integer <int32>
Request Body schema:
Name
string or null
object (EndSubscriptionModel)
object (SubscriptionRecurrenceModel)
FinalizationMode
required
string
Enum: "Draft" "Invoice" "InvoiceAndSendMail"
object (SubscriptionMailConfigurationModel)
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
ShowDeliveryAddress
boolean or null
RowVersion
required
string

Responses

Request samples

Content type
{
  • "Name": "string",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "FinalizationMode": "Draft",
  • "MailConfiguration": {
    },
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "ShowDeliveryAddress": true,
  • "RowVersion": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "CreateDate": "2019-08-24T14:15:22Z",
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "FinalizationMode": "Draft",
  • "Status": "Active",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "Template": {
    },
  • "SubscriptionEmailConfig": {
    },
  • "ScheduledActions": [
    ],
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RowVersion": "string"
}

Subscription_DeleteSubscription

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
subscriptionId
required
integer <int32>

Responses

Subscription_SearchSubscriptions

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 10
SearchText
string or null
StartDate
string or null <date-time>
EndDate
string or null <date-time>
SortColumn
required
string
Enum: "Name" "BuyerName" "Status" "CreationDate" "EndDate" "TotalPriceInclTax"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 10,
  • "SearchText": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "EndDate": "2019-08-24T14:15:22Z",
  • "SortColumn": "Name",
  • "SortDirection": "Ascending"
}

Response samples

Content type
{
  • "Items": [
    ],
  • "PageNumber": 1,
  • "PageSize": 1,
  • "TotalCount": 1,
  • "PageCount": 0,
  • "HasPreviousPage": false,
  • "HasNextPage": false
}

Subscription_CreateSubscription Deprecated

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
Name
string or null
object (EndSubscriptionModel)
object (SubscriptionRecurrenceModel)
FinalizationMode
required
string
Enum: "Draft" "Invoice" "InvoiceAndSendMail"
object (SubscriptionMailConfigurationModel)
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)
BankAccountInfoId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
LatePenaltyText
string or null
FreeTextField
string or null
DiscountConditionsFreeTextField
required
string non-empty
PublicTenderIdentifier
string or null
Array of objects or null (DocumentSectionModel)
RecoveryIndemnityText
string or null
ShowDeliveryAddress
boolean or null
CustomerIds
Array of integers or null <int32> [ items <int32 > ]
StartDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "Name": "string",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "FinalizationMode": "Draft",
  • "MailConfiguration": {
    },
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    },
  • "BankAccountInfoId": 0,
  • "PaymentTerms": "OnReceipt",
  • "LatePenaltyText": "string",
  • "FreeTextField": "string",
  • "DiscountConditionsFreeTextField": "string",
  • "PublicTenderIdentifier": "string",
  • "Sections": [
    ],
  • "RecoveryIndemnityText": "string",
  • "ShowDeliveryAddress": true,
  • "CustomerIds": [
    ],
  • "StartDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
[
  • {
    }
]

Subscription_UpdateSubscriptionStatus

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
subscriptionId
required
integer <int32>
Request Body schema:
string
Enum: "Active" "Suspended" "Cancel" "Finished"

Responses

Request samples

Content type
"Active"

Response samples

Content type
{
  • "Id": 0,
  • "AccountingFolderId": 0,
  • "Name": "string",
  • "CreateDate": "2019-08-24T14:15:22Z",
  • "BuyerId": 0,
  • "BuyerName": "string",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "FinalizationMode": "Draft",
  • "Status": "Active",
  • "EndSubscription": {
    },
  • "Recurrence": {
    },
  • "Template": {
    },
  • "SubscriptionEmailConfig": {
    },
  • "ScheduledActions": [
    ],
  • "VatLegalNoticeType": "ExemptionArticle261D4",
  • "VatLegalNoticeText": "string",
  • "RowVersion": "string"
}

SubscriptionScheduledAction

Preview scheduled actions with DueDate and TotalDocumentInclTax computation support

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>

Accounting Folder Identifier

Request Body schema:

Preview scheduled actions query with payment terms and product line items

StartDate
required
string <date-time>
object (SubscriptionRecurrenceModel)
object (EndSubscriptionModel)
SubscriptionId
integer or null <int32>
PaymentTerms
string or null
Enum: "OnReceipt" "Within30Days" "Within45Days" "Within60Days" "Custom"
Array of objects or null (ProductLineItemsModel)
object (DocumentDiscountCommandModel)

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Recurrence": {
    },
  • "EndSubscription": {
    },
  • "SubscriptionId": 0,
  • "PaymentTerms": "OnReceipt",
  • "ProductLineItems": [
    ],
  • "CreateDocumentDiscountCommand": {
    }
}

Response samples

Content type
[
  • {
    }
]

SubscriptionScheduledAction_PreviewScheduledActions

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
object (SubscriptionRecurrenceModel)
object (EndSubscriptionModel)
SubscriptionId
integer or null <int32>

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Recurrence": {
    },
  • "EndSubscription": {
    },
  • "SubscriptionId": 0
}

Response samples

Content type
[
  • {
    }
]

SubscriptionScheduledAction_SearchScheduledActions

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 10
Statuses
Array of strings or null
Enum: "ToCome" "Disabled" "Processed" "Failed"
FinalizationModes
Array of strings or null
Enum: "Draft" "Invoice" "InvoiceAndSendMail"
SortColumn
required
string
Enum: "Date" "Status"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 10,
  • "Statuses": [
    ],
  • "FinalizationModes": [
    ],
  • "SortColumn": "Date",
  • "SortDirection": "Ascending"
}

Response samples

Content type
{
  • "Items": [
    ],
  • "PageNumber": 1,
  • "PageSize": 1,
  • "TotalCount": 1,
  • "PageCount": 0,
  • "HasPreviousPage": false,
  • "HasNextPage": false
}

SubscriptionScheduledAction_GenerateSubscriptionScheduledActionsForDate

Authorizations:
oauth2
query Parameters
date
string <date-time>

Responses

SubscriptionScheduledAction_UpdateSubscriptionScheduledActionStatus

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
scheduledActionId
required
integer <int32>
Request Body schema:
string
Enum: "ToCome" "Disabled" "Processed" "Failed"

Responses

Request samples

Content type
"ToCome"

Response samples

Content type
{
  • "Id": 0,
  • "Order": 0,
  • "Date": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "TotalDocumentInclTax": 0,
  • "Status": "ToCome",
  • "RowVersion": "string"
}

Transaction

Get all bank transactions related to an accounting folder

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 10
BankAccountId
integer or null <int32>
DateGreateaOrEqualAt
string or null <date-time>
DateLowerOrEqualAt
string or null <date-time>
Label
string or null
AmountGreaterOrEqualAt
number or null <double>
AmountLowerOrEqualAt
number or null <double>
IsStrictlyPositive
boolean or null
SortColumn
string or null
Enum: "OperationDate" "Amount"
SortDirection
string or null
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 10,
  • "BankAccountId": 0,
  • "DateGreateaOrEqualAt": "2019-08-24T14:15:22Z",
  • "DateLowerOrEqualAt": "2019-08-24T14:15:22Z",
  • "Label": "string",
  • "AmountGreaterOrEqualAt": 0.1,
  • "AmountLowerOrEqualAt": 0.1,
  • "IsStrictlyPositive": true,
  • "SortColumn": "OperationDate",
  • "SortDirection": "Ascending"
}

Response samples

Content type
{
  • "Items": [
    ],
  • "PageNumber": 1,
  • "PageSize": 1,
  • "TotalCount": 1,
  • "PageCount": 0,
  • "HasPreviousPage": false,
  • "HasNextPage": false
}

VatRate

Get all available vat rates

Authorizations:
oauth2

Responses

Response samples

Content type
[
  • {
    }
]