API docs by Redocly

Fred Payment Api (v1)

Download OpenAPI specification:

Introduction

L’API Payment centralise la gestion du cycle de facturation et des paiements, couvrant clients/fournisseurs, produits, devis, factures (achat/vente, avoirs, acomptes), brouillons et abonnements. Elle expose des endpoints pour créer, lister et mettre à jour les tiers, orchestrer des règlements individuels ou en lots avec validations intégrées (statuts, IBAN, mandats, volumes) et accéder aux données transactionnelles et à l’audit des documents. Elle s’intègre aux paramètres comptables et d’apparence des dossiers, et est disponible en environnements de recette et de production.

Authentication

Voir : Authentification API Inqom

Accounts

AgingSchedule

Get the aging schedule

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
ExerciceStartDate
required
string <date-time>
ExerciceEndDate
required
string <date-time>
Type
required
string
Enum: "SellInvoice" "BuyInvoice"
AgingDate
required
string <date-time>
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
AccountBalanceStatuses
Array of strings or null
Enum: "Balanced" "Unbalanced"

Responses

Request samples

Content type
{
  • "ExerciceStartDate": "2019-08-24T14:15:22Z",
  • "ExerciceEndDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "AgingDate": "2019-08-24T14:15:22Z",
  • "PaymentModes": [
    ],
  • "AccountBalanceStatuses": [
    ]
}

Response samples

Content type
{
  • "Lines": [
    ],
  • "Total": {
    }
}

Export the aging schedule

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
object (GetAgingScheduleQuery)
ExportFormat
required
string
Enum: "Excel" "Pdf"

Responses

Request samples

Content type
{
  • "SearchQuery": {
    },
  • "ExportFormat": "Excel"
}

Response samples

Content type
"string"

CustomerParameters

Get the customer parameter for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "SepaCreditorIdentifier": "string",
  • "DefaultPaymentTerm": {
    }
}

Create or update the customer parameter for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
SepaCreditorIdentifier
string or null
object (PaymentTerm)

Responses

Request samples

Content type
{
  • "SepaCreditorIdentifier": "string",
  • "DefaultPaymentTerm": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "SepaCreditorIdentifier": "string",
  • "DefaultPaymentTerm": {
    }
}

Customers

Update customer information

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
customerId
required
integer <int32>
Request Body schema:
required
Iban
string or null
Bic
string or null
AccountHolderName
string or null <= 70 characters
Siren
string or null
Nic
string or null
PaymentMode
string or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
required
object (PaymentTerm)
object (DebitMandate)
Note
string or null
object (AccountCommand)
object (AccountCommand)
object (AccountCommand)
object (AccountCommand)
LegalName
string or null

Responses

Request samples

Content type
{
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "DebitMandate": {
    },
  • "Note": "string",
  • "SellAccount": {
    },
  • "DownPaymentAccount": {
    },
  • "ProductAccount": {
    },
  • "VatAccount": {
    },
  • "LegalName": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Account": {
    },
  • "SellAccount": {
    },
  • "DoubtfulAccount": {
    },
  • "DownPaymentAccount": {
    },
  • "ProductAccount": {
    },
  • "VatAccount": {
    },
  • "IsValid": true,
  • "Siret": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "DebitMandate": {
    },
  • "Note": "string",
  • "LegalName": "string"
}

Creates or updates a customer in a single action, keeping Payment and Billing consistent.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
Request Body schema:
required
CustomerId
integer or null <int32>
BillingCustomerId
integer or null <int32>
ClientType
required
string
Enum: "Enterprise" "Individual" "ForeignEnterprise"
LegalName
string or null
Siren
string or null
Nic
string or null
Registration
string or null
FirstName
string or null
LastName
string or null
VatNumber
string or null
Reference
string or null
Email
string or null
PhoneNumber
string or null
EmailsCc
Array of strings or null
EmailsBcc
Array of strings or null
object (AddressInput)
object (AddressInput)
ExcludedFromReminders
required
boolean
object (PaymentTermInput)
PaymentMode
string or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
Iban
string or null
Bic
string or null
AccountHolderName
string or null <= 70 characters
object (DebitMandateInput)
Note
string or null

Responses

Request samples

Content type
{
  • "CustomerId": 0,
  • "BillingCustomerId": 0,
  • "ClientType": "Enterprise",
  • "LegalName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Registration": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "VatNumber": "string",
  • "Reference": "string",
  • "Email": "string",
  • "PhoneNumber": "string",
  • "EmailsCc": [
    ],
  • "EmailsBcc": [
    ],
  • "BillingAddress": {
    },
  • "DeliveryAddress": {
    },
  • "ExcludedFromReminders": true,
  • "PaymentTerm": {
    },
  • "PaymentMode": "Unknown",
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "DebitMandate": {
    },
  • "Note": "string"
}

Response samples

Content type
{
  • "Id": 0,
  • "ClientType": "Enterprise",
  • "LegalName": "string",
  • "Siren": "string",
  • "Registration": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "PaymentTerm": {
    }
}

Returns the merged Payment + Billing view of a customer to pre-fill the unified edit form.

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
query Parameters
id
required
integer <int32>
idSource
required
string
Enum: "Payment" "Billing"

Responses

Response samples

Content type
{
  • "PaymentCustomerId": 0,
  • "BillingCustomerId": 0,
  • "ClientType": "string",
  • "LegalName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Registration": "string",
  • "VatNumber": "string",
  • "FirstName": "string",
  • "LastName": "string",
  • "Reference": "string",
  • "Note": "string",
  • "BillingState": "Present",
  • "Billing": {
    },
  • "Payment": {
    },
  • "BankDetails": {
    }
}

Get all customers for a given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get all customers for a given enterprise that have at least one invoice

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get customer account availability

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
required
integer <int32>
subAccountId
required
integer <int32>

Responses

Response samples

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

Update customer information Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
customerId
required
integer <int32>
Request Body schema:
required
Iban
string or null
Bic
string or null
AccountHolderName
string or null <= 70 characters
Siret
string or null
PaymentMode
string or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
required
object (PaymentTerm)
object (DebitMandate)
Note
string or null
object (AccountCommand)

Responses

Request samples

Content type
{
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Siret": "string",
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "DebitMandate": {
    },
  • "Note": "string",
  • "DownPaymentAccount": {
    }
}

Response samples

Content type
{
  • "Id": 0,
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Account": {
    },
  • "SellAccount": {
    },
  • "DoubtfulAccount": {
    },
  • "DownPaymentAccount": {
    },
  • "ProductAccount": {
    },
  • "VatAccount": {
    },
  • "IsValid": true,
  • "Siret": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "DebitMandate": {
    },
  • "Note": "string",
  • "LegalName": "string"
}

Get all down payment accounts available for a customer

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

Responses

Response samples

Content type
[
  • {
    }
]

Get all available tier accounts for customers (not already assigned to a customer fiche)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
customerId
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Search customers by free-text (legal name or account label), Siren, Nic, sub-account code, etc.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 100
Default: 100
SearchText
string or null
Siren
string or null
Nic
string or null
SubAccountCode
string or null
HavingInvoices
boolean or null
IsValid
boolean or null
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
SortColumn
required
string
Enum: "AccountLabel" "AccountNumber" "IsValid" "LegalName"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 100,
  • "SearchText": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "SubAccountCode": "string",
  • "HavingInvoices": true,
  • "IsValid": true,
  • "PaymentModes": [
    ],
  • "SortColumn": "AccountLabel",
  • "SortDirection": "Ascending"
}

Response samples

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

Create or update customers in bulk

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

Request Body schema:
required

The bulk create/update command

required
Array of objects (CreateOrUpdateCustomerCommand)

Responses

Request samples

Content type
{
  • "Customers": [
    ]
}

Response samples

Content type
{
  • "CreatedCount": 0,
  • "UpdatedCount": 0,
  • "FailedCount": 0,
  • "TotalCount": 0,
  • "Errors": [
    ]
}

Import customers in bulk from an uploaded CSV/XLSX file. The file is parsed and de-duplicated server-side, then processed through the bulk create/update flow.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

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

Responses

Response samples

Content type
{
  • "CreatedCount": 0,
  • "UpdatedCount": 0,
  • "FailedCount": 0,
  • "TotalCount": 0,
  • "Errors": [
    ]
}

Download the customer import template (CSV or XLSX). Required columns are marked with '*'.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

Request Body schema:

Requested file format (CSV or XLSX)

FileType
required
string
Enum: "Csv" "Xlsx"

Responses

Request samples

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

Response samples

Content type
"string"

InvoiceBatches

Get all invoice batches for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Create a new invoice batch for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Type
required
string
Enum: "Payment" "Debit"
Name
required
string non-empty
PaymentDate
required
string <date-time>
BankAccountId
integer or null <int32>
Iban
required
string non-empty
Bic
string or null
InvoiceIds
required
Array of integers <int32> [ items <int32 > ]
Status
required
string
Enum: "Pending" "Validated" "Reconciliated" "Failed"
UngroupTransactionByOwner
required
boolean

Responses

Request samples

Content type
{
  • "Type": "Payment",
  • "Name": "string",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "InvoiceIds": [
    ],
  • "Status": "Pending",
  • "UngroupTransactionByOwner": true
}

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Get the invoice batch for the given enterprise and invoice batch id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Update the invoice batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>
Request Body schema:
Name
string or null
PaymentDate
required
string <date-time>
BankAccountId
integer or null <int32>
Iban
string or null
Bic
string or null
UngroupTransactionByOwner
required
boolean

Responses

Request samples

Content type
{
  • "Name": "string",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "UngroupTransactionByOwner": true
}

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Delete the invoice batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

Responses

Get the invoice batch for the given enterprise and entry id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Get the invoice batches for the given enterprise and entry ids

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
Array
integer <int32>

Responses

Request samples

Content type
[
  • 0
]

Response samples

Content type
[
  • {
    }
]

Get the invoice batch metrics for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
{
  • "CurrentMonthCounts": [
    ]
}

Download the invoice batch xml

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

Responses

Response samples

Content type
"string"

Search invoice batches for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
ExerciceStartDate
string or null <date-time>
ExerciceEndDate
string or null <date-time>
Type
required
string
Enum: "Payment" "Debit"
Name
string or null
InvoiceBatchStatus
string or null
Enum: "Pending" "Validated" "Reconciliated" "Failed"

Responses

Request samples

Content type
{
  • "ExerciceStartDate": "2019-08-24T14:15:22Z",
  • "ExerciceEndDate": "2019-08-24T14:15:22Z",
  • "Type": "Payment",
  • "Name": "string",
  • "InvoiceBatchStatus": "Pending"
}

Response samples

Content type
[
  • {
    }
]

Add invoices in batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>
Request Body schema:
InvoiceIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ]
}

Remove invoices from batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
InvoiceIds
required
Array of integers <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ]
}

Validate the invoice batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Invalidate the invoice batch

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "Status": "Pending",
  • "Type": "Payment",
  • "Name": "string",
  • "ValidationDate": "2019-08-24T14:15:22Z",
  • "PaymentDate": "2019-08-24T14:15:22Z",
  • "InvoiceCount": 0,
  • "TotalAmount": 0,
  • "BankAccountId": 0,
  • "Iban": "string",
  • "Bic": "string",
  • "AnomalyCode": "string",
  • "HasAnomaly": true,
  • "UngroupTransactionByOwner": true,
  • "Mode": "SepaTransfer",
  • "BridgePaymentInfo": {
    },
  • "SourcePlatform": "Web",
  • "BankCoordinatesHistory": [
    ],
  • "Payments": [
    ]
}

Export Invoice Batch Execution Report to PDF for an invoice batch payment

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceBatchId
required
integer <int32>

The invoice batch ID for the payment

Responses

Response samples

Content type
"string"

InvoiceQualifications

Get the list of invoice qualifications for a specific sell invoice.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
sellInvoiceId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get the invoice qualification for a specific entry line.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
entryId
required
integer <int32>
entryLineId
required
integer <int64>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "SellInvoiceId": 0,
  • "Date": "2019-08-24",
  • "Status": "None",
  • "Cause": "Other",
  • "DepreciationRate": 0,
  • "IsReviewed": true,
  • "EntryGenerated": true
}

Search for untrusted invoices.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 100
ExerciceEndDate
required
string <date-time>
Date
required
string <date-time>
CurrentStatus
Array of strings or null
Enum: "None" "Doubtful" "Irrecoverable" "Collected" "SettledByCredit"
PreviousStatus
Array of strings or null
Enum: "None" "Doubtful" "Irrecoverable" "Collected" "SettledByCredit"
DueDateRanges
Array of strings or null
Enum: "Unknown" "LessThan90" "From90To61" "From60To31" "From30To1" "From0To30" "From31To60" "MoreThan60"
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
CustomerIds
Array of integers or null <int32> [ items <int32 > ]
SortColumn
required
string
Enum: "Reference" "Date" "DueDate" "TotalAmount"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 100,
  • "ExerciceEndDate": "2019-08-24T14:15:22Z",
  • "Date": "2019-08-24T14:15:22Z",
  • "CurrentStatus": [
    ],
  • "PreviousStatus": [
    ],
  • "DueDateRanges": [
    ],
  • "PaymentModes": [
    ],
  • "CustomerIds": [
    ],
  • "SortColumn": "Reference",
  • "SortDirection": "Ascending"
}

Response samples

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

Set the qualifications for a list of untrusted invoices.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
InvoiceIds
required
Array of integers <int32> [ items <int32 > ]
Status
required
string
Enum: "None" "Doubtful" "Irrecoverable" "Collected" "SettledByCredit"
Date
required
string <date>
DepreciationRate
number or null <decimal>
IsReviewed
required
boolean
Array of objects or null (Vat)
Cause
string or null
Enum: "Other" "Recovery" "Litigation" "CollectiveProcedureBackup" "CollectiveProcedureRedress" "CollectiveProcedureLiquidation"

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ],
  • "Status": "None",
  • "Date": "2019-08-24",
  • "DepreciationRate": 0,
  • "IsReviewed": true,
  • "Vats": [
    ],
  • "Cause": "Other"
}

Response samples

Content type
[
  • {
    }
]

Update the qualification review for a list of untrusted invoices.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
InvoiceIds
required
Array of integers <int32> [ items <int32 > ]
IsReviewed
required
boolean
ExerciceEndDate
required
string <date>

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ],
  • "IsReviewed": true,
  • "ExerciceEndDate": "2019-08-24"
}

Response samples

Content type
[
  • {
    }
]

Copy the previous qualification for an enterprise and exercice.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
ExerciceEndDate
required
string <date-time>
Date
required
string <date-time>
CurrentStatus
Array of strings or null
Enum: "None" "Doubtful" "Irrecoverable" "Collected" "SettledByCredit"
PreviousStatus
Array of strings or null
Enum: "None" "Doubtful" "Irrecoverable" "Collected" "SettledByCredit"
DueDateRanges
Array of strings or null
Enum: "Unknown" "LessThan90" "From90To61" "From60To31" "From30To1" "From0To30" "From31To60" "MoreThan60"
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
CustomerIds
Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Content type
{
  • "ExerciceEndDate": "2019-08-24T14:15:22Z",
  • "Date": "2019-08-24T14:15:22Z",
  • "CurrentStatus": [
    ],
  • "PreviousStatus": [
    ],
  • "DueDateRanges": [
    ],
  • "PaymentModes": [
    ],
  • "CustomerIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Generate the qualification entries for an enterprise and exercice.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
ExerciceEndDate
required
string <date-time>

Responses

Request samples

Content type
{
  • "ExerciceEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "GeneratedEntriesCount": 0
}

Get the state of untrusted invoices for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Export the state of untrusted invoices to PDF for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date-time>

Responses

Response samples

Content type
"string"

Get the state of depreciation for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date-time>

Responses

Response samples

Content type
[
  • {
    }
]

Get the total state of depreciation for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date-time>

Responses

Response samples

Content type
{
  • "TotalDepreciationDotation": 0,
  • "TotalDepreciationReprise": 0
}

Export the state of depreciation to PDF for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date-time>

Responses

Response samples

Content type
"string"

Get the reconciliation state of untrusted invoices for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date>

Responses

Response samples

Content type
{
  • "CurrentDate": "2019-08-24",
  • "PreviousDate": "2019-08-24",
  • "Categories": [
    ]
}

Export the reconciliation state of untrusted invoices to PDF for a specific period.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
periodEndDate
required
string <date>

Responses

Response samples

Content type
"string"

Invoices

Get Invoice By Id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceId
required
integer <int32>
query Parameters
invoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"

Responses

Response samples

Content type
{
  • "Id": 0,
  • "EntryId": 0,
  • "EntryLineId": 0,
  • "EntryLineLabel": "string",
  • "DocumentId": 0,
  • "DocumentSourceType": "Billing",
  • "SupplierId": 0,
  • "CustomerId": 0,
  • "TotalAmount": 0,
  • "RemainingAmount": 0,
  • "Currency": "string",
  • "DocRef": "string",
  • "Date": "2019-08-24T14:15:22Z",
  • "DueDate": "2019-08-24T14:15:22Z",
  • "InitialDueDate": "2019-08-24T14:15:22Z",
  • "DueDateSource": "Calculated",
  • "HasAnomaly": true,
  • "AnomalyCode": "string",
  • "EntryDeletedInAccounting": true,
  • "AccountingStatus": "Unknown",
  • "ViDAStatus": "None",
  • "ViDAState": "Pending",
  • "ViDAStatusDetails": "string",
  • "Account": {
    },
  • "InvoiceType": "SellInvoice",
  • "Vats": [
    ],
  • "DownPayments": [
    ],
  • "PartialPayments": [
    ]
}

Force invoice delete for invoice without entry in accounting

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"

Responses

Request samples

Content type
{
  • "InvoiceType": "SellInvoice"
}

Get Invoice Vats

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceId
required
integer <int32>
query Parameters
invoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"

Responses

Response samples

Content type
[
  • {
    }
]

Retrieves the history entries for a specific invoice within the specified enterprise.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The unique identifier of the enterprise containing the invoice. Must not be the default value.

Request Body schema:

An object containing the parameters required to query the invoice history.

InvoiceId
required
integer <int32>
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"

Responses

Request samples

Content type
{
  • "InvoiceId": 0,
  • "InvoiceType": "SellInvoice"
}

Response samples

Content type
[
  • {
    }
]

Search Invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 1000
Default: 100
ExerciceStartDate
string or null <date-time>
ExerciceEndDate
string or null <date-time>
Type
required
string
Enum: "SellInvoice" "BuyInvoice"
Status
Array of strings or null
Enum: "Unknown" "ToPay" "Paid" "PartiallyPaid" "InPreparation" "Sold" "Unpaid"
DueDateRanges
Array of strings or null
Enum: "Unknown" "LessThan90" "From90To61" "From60To31" "From30To1" "From0To30" "From31To60" "MoreThan60"
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
OwnerId
integer or null <int32>
InvoiceBatchId
integer or null <int32>
SortColumn
required
string
Enum: "Status" "Date" "DueDate" "TotalAmount" "HasAnomaly" "OwnerName" "RemainingAmount" "ViDAStatus"
SortDirection
required
string
Enum: "Ascending" "Descending"
DocumentTypes
Array of strings or null
Enum: "Invoice" "CreditNote"
DueDateStart
string or null <date-time>
DueDateEnd
string or null <date-time>
SearchText
string or null
ViDAStatus
Array of strings or null
Enum: "None" "Deposited" "IssuedByPlatform" "ReceivedFromPlatform" "Available" "Processing" "Approved" "PartiallyApproved" "InDispute" "Suspended" "Completed" "Refused" "PaymentTransmitted" "Cashed" "Rejected" "Targeted" "Cancelled" "RoutingError" "PayerAccountChange" "Inadmissible" "LifeCycleRejected" "Scheduled"
SourceType
string or null
Enum: "Billing" "ViDA"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 100,
  • "ExerciceStartDate": "2019-08-24T14:15:22Z",
  • "ExerciceEndDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "Status": [
    ],
  • "DueDateRanges": [
    ],
  • "PaymentModes": [
    ],
  • "OwnerId": 0,
  • "InvoiceBatchId": 0,
  • "SortColumn": "Status",
  • "SortDirection": "Ascending",
  • "DocumentTypes": [
    ],
  • "DueDateStart": "2019-08-24T14:15:22Z",
  • "DueDateEnd": "2019-08-24T14:15:22Z",
  • "SearchText": "string",
  • "ViDAStatus": [
    ],
  • "SourceType": "Billing"
}

Response samples

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

Search Invoice Payments

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
EntryLineIds
required
Array of integers or null <int64> [ items <int64 > ]

Responses

Request samples

Content type
{
  • "EntryLineIds": [
    ]
}

Response samples

Content type
[
  • {
    }
]

Get metrics for supplier or customer invoices

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"
ExerciseStartDate
string or null <date-time>
ExerciseEndDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "InvoiceType": "SellInvoice",
  • "ExerciseStartDate": "2019-08-24T14:15:22Z",
  • "ExerciseEndDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "CountByInvoiceStatus": {
    }
}

Update Invoice Due Date

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
required
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"
DueDate
string or null <date-time>

Responses

Request samples

Content type
{
  • "InvoiceType": "SellInvoice",
  • "DueDate": "2019-08-24T14:15:22Z"
}

Update Invoice Due Date

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
Array of objects or null (UpdateDueDateCommandBase) <= 1000 items

Responses

Request samples

Content type
{
  • "Invoices": [
    ]
}

Update Invoice Payments

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
invoiceId
required
integer <int32>
Request Body schema:
required
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"
required
Array of objects or null (PaymentEntryLine)

Responses

Request samples

Content type
{
  • "InvoiceType": "SellInvoice",
  • "PaymentEntryLines": [
    ]
}

Update Invoice Supplier

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
InvoiceIds
required
Array of integers or null <int32> [ items <int32 > ]
AccountId
required
integer <int32>
SubAccountId
required
integer <int32>

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ],
  • "AccountId": 0,
  • "SubAccountId": 0
}

Update Invoice customer

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
required
InvoiceIds
required
Array of integers or null <int32> [ items <int32 > ]
AccountId
required
integer <int32>
SubAccountId
required
integer <int32>

Responses

Request samples

Content type
{
  • "InvoiceIds": [
    ],
  • "AccountId": 0,
  • "SubAccountId": 0
}

PaymentInvoices_RefuseInvoice

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
InvoiceId
required
integer <int32>
InvoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"
ReasonCode
string or null
Enum: "NON_TRANSMISE" "JUSTIF_ABS" "ROUTAGE_ERR" "AUTRE" "COORD_BANC_ERR" "TX_TVA_ERR" "MONTANTTOTAL_ERR" "CALCUL_ERR" "NON_CONFORME" "DOUBLON" "DEST_INC" "DEST_ERR" "TRANSAC_INC" "EMMET_INC" "CONTRAT_TERM" "DOUBLE_FACT" "CMD_ERR" "ADR_ERR" "SIRET_ERR" "CODE_ROUTAGE_ERR" "REF_CT_ABSENT" "REF_ERR" "PU_ERR" "REM_ERR" "QTE_ERR" "ART_ERR" "MODPAI_ERR" "QUALITE_ERR" "LIVR_INCOMP" "REJ_SEMAN" "REJ_UNI" "REJ_COH" "REJ_ADR" "REJ_CONT_B2G" "REJ_REF_PJ" "REJ_ASS_PJ" "IRR_VIDE_F" "IRR_TYPE_F" "IRR_SYNTAX" "IRR_TAILLE_PJ" "IRR_NOM_PJ" "IRR_VID_PJ" "IRR_EXT_DOC" "IRR_TAILLE_F" "IRR_ANTIVIRUS"
ReasonText
string or null

Responses

Request samples

Content type
{
  • "InvoiceId": 0,
  • "InvoiceType": "SellInvoice",
  • "ReasonCode": "NON_TRANSMISE",
  • "ReasonText": "string"
}

SupplierParameters

Get the supplier parameter for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "DefaultDueDateCalculationMode": "PaymentTerm",
  • "SepaJournalId": 0,
  • "DirectJournalId": 0,
  • "DefaultJournalName": "string",
  • "DefaultJournalDescription": "string"
}

Create or update the supplier parameter for the given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
DefaultDueDateCalculationMode
required
string
Enum: "PaymentTerm" "Extracted"
SepaJournalId
integer or null <int32>
DirectJournalId
integer or null <int32>

Responses

Request samples

Content type
{
  • "DefaultDueDateCalculationMode": "PaymentTerm",
  • "SepaJournalId": 0,
  • "DirectJournalId": 0
}

Response samples

Content type
{
  • "Id": 0,
  • "DefaultDueDateCalculationMode": "PaymentTerm",
  • "SepaJournalId": 0,
  • "DirectJournalId": 0,
  • "DefaultJournalName": "string",
  • "DefaultJournalDescription": "string"
}

Suppliers

Update supplier information for a given enterprise

Authorizations:
oauth2
path Parameters
accountingFolderId
required
integer <int32>
supplierId
required
integer <int32>
Request Body schema:
required
Iban
string or null
Bic
string or null
AccountHolderName
string or null <= 70 characters
Siren
string or null
Nic
string or null
PaymentMode
string or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
required
object (PaymentTerm)
Note
string or null
object (AccountCommand)
object (AccountCommand)
object (AccountCommand)
object (AccountCommand)
LegalName
string or null
DueDateCalculationMode
string or null
Enum: "PaymentTerm" "Extracted"

Responses

Request samples

Content type
{
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Note": "string",
  • "SupplierAccount": {
    },
  • "DownPaymentAccount": {
    },
  • "ChargeAccount": {
    },
  • "VatAccount": {
    },
  • "LegalName": "string",
  • "DueDateCalculationMode": "PaymentTerm"
}

Response samples

Content type
{
  • "Id": 0,
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Account": {
    },
  • "IsValid": true,
  • "Siret": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Note": "string",
  • "LegalName": "string",
  • "BankCoordinatesHistory": [
    ],
  • "DownPaymentAccount": {
    },
  • "ChargeAccount": {
    },
  • "VatAccount": {
    },
  • "DueDateCalculationMode": "PaymentTerm"
}

Get all suppliers for a given enterprise

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get all suppliers for a given enterprise that have at least one invoice

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get supplier account availability

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
accountId
required
integer <int32>
subAccountId
required
integer <int32>

Responses

Response samples

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

Update supplier information for a given enterprise Deprecated

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
supplierId
required
integer <int32>
Request Body schema:
required
Iban
string or null
Bic
string or null
AccountHolderName
string or null <= 70 characters
Siret
string or null
PaymentMode
string or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
required
object (PaymentTerm)
Note
string or null
object (AccountCommand)
DueDateCalculationMode
string or null
Enum: "PaymentTerm" "Extracted"

Responses

Request samples

Content type
{
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Siret": "string",
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Note": "string",
  • "DownPaymentAccount": {
    },
  • "DueDateCalculationMode": "PaymentTerm"
}

Response samples

Content type
{
  • "Id": 0,
  • "PaymentMode": "Unknown",
  • "PaymentTerm": {
    },
  • "Iban": "string",
  • "Bic": "string",
  • "AccountHolderName": "string",
  • "Account": {
    },
  • "IsValid": true,
  • "Siret": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "Note": "string",
  • "LegalName": "string",
  • "BankCoordinatesHistory": [
    ],
  • "DownPaymentAccount": {
    },
  • "ChargeAccount": {
    },
  • "VatAccount": {
    },
  • "DueDateCalculationMode": "PaymentTerm"
}

Get all down payment accounts available for a supplier

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
supplierId
required
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Get all available tier accounts for suppliers (not already assigned to a supplier fiche)

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
supplierId
integer <int32>

Responses

Response samples

Content type
[
  • {
    }
]

Search suppliers by free-text (legal name or account label), Siren, Nic, sub-account code, etc.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
PageNumber
required
integer <int32>
Default: 1
PageSize
required
integer <int32> <= 100
Default: 100
SearchText
string or null
Siren
string or null
Nic
string or null
SubAccountCode
string or null
HavingInvoices
boolean or null
IsValid
boolean or null
PaymentModes
Array of strings or null
Enum: "Unknown" "Check" "Transfer" "DirectDebit" "BankCard" "Cash" "BillOfExchange" "Other"
SortColumn
required
string
Enum: "AccountLabel" "AccountNumber" "IsValid" "LegalName"
SortDirection
required
string
Enum: "Ascending" "Descending"

Responses

Request samples

Content type
{
  • "PageNumber": 1,
  • "PageSize": 100,
  • "SearchText": "string",
  • "Siren": "string",
  • "Nic": "string",
  • "SubAccountCode": "string",
  • "HavingInvoices": true,
  • "IsValid": true,
  • "PaymentModes": [
    ],
  • "SortColumn": "AccountLabel",
  • "SortDirection": "Ascending"
}

Response samples

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

Create or update suppliers in batch. Suppliers are identified by AccountName (resolved to AccountId + SubAccountId).

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

Request Body schema:
required

The bulk create/update command

required
Array of objects (CreateOrUpdateSupplierCommand)

Responses

Request samples

Content type
{
  • "Suppliers": [
    ]
}

Response samples

Content type
{
  • "CreatedCount": 0,
  • "UpdatedCount": 0,
  • "FailedCount": 0,
  • "TotalCount": 0,
  • "Errors": [
    ]
}

Import suppliers in bulk from an uploaded CSV/XLSX file. The file is parsed and de-duplicated server-side, then processed through the bulk create/update flow.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

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

Responses

Response samples

Content type
{
  • "CreatedCount": 0,
  • "UpdatedCount": 0,
  • "FailedCount": 0,
  • "TotalCount": 0,
  • "Errors": [
    ]
}

Download the supplier import template (CSV or XLSX). Required columns are marked with '*'.

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>

The accounting folder ID

Request Body schema:

Requested file format (CSV or XLSX)

FileType
required
string
Enum: "Csv" "Xlsx"

Responses

Request samples

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

Response samples

Content type
"string"

Synchronizations

Get active synchronization for a given enterprise and invoice type if any

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
query Parameters
invoiceType
required
string
Enum: "SellInvoice" "BuyInvoice"

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Status": "InProgress",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "IncludeDoubtfulAccounts": true,
  • "FailureReason": {
    }
}

Get synchronization for a given enterprise and synchronization id

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
synchronizationId
required
integer <int32>

Responses

Response samples

Content type
{
  • "Id": 0,
  • "Status": "InProgress",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "IncludeDoubtfulAccounts": true,
  • "FailureReason": {
    }
}

Start synchronization for a given enterprise and start date

Authorizations:
oauth2
path Parameters
enterpriseId
required
integer <int32>
Request Body schema:
StartDate
required
string <date-time>
Type
required
string
Enum: "SellInvoice" "BuyInvoice"
IncludeDoubtfulAccounts
boolean or null

Responses

Request samples

Content type
{
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "IncludeDoubtfulAccounts": true
}

Response samples

Content type
{
  • "Id": 0,
  • "Status": "InProgress",
  • "StartDate": "2019-08-24T14:15:22Z",
  • "Type": "SellInvoice",
  • "IncludeDoubtfulAccounts": true,
  • "FailureReason": {
    }
}

Webhooks

Bridge webhook endpoint

Authorizations:
oauth2

Responses