Dolibarr

App · 15 actions

Run sales and billing in Dolibarr from workflows: add customers, prospects and suppliers from forms and sales, add contacts, make and validate invoices, record payments, save invoice and quote PDFs to send, and find unpaid or overdue invoices and products. Start a workflow when a third party is added or an invoice is issued or paid.

Actions

ActionWhat it does
Add payment to invoiceRecord money received against a validated invoice.
Close proposalMark a proposal signed or not signed, such as when the customer accepts or turns it down.
Create contactAdd a contact person, at a third party or on their own.
Create invoiceMake a customer invoice with its lines, as a draft or validated with its number.
Create proposalMake a proposal (a quote) for a customer with its lines, as a draft or validated with its number.
Create third partyAdd a customer, prospect or supplier.
Download invoice PDFSave an invoice's PDF as a file in Lodol, to attach to an email or store elsewhere.
Download proposal PDFSave a proposal's PDF as a file in Lodol, to email to the customer.
Find invoicesFind customer invoices by status, customer, number or date, such as every unpaid or overdue one, newest first.
Find productsFind products and services by words in their ref, label or barcode, with their price and VAT rate.
Find third partiesFind customers, prospects and suppliers by words in their name, alias, email or customer code, newest first.
Get invoiceGet an invoice's details, its lines and the payments made on it.
Get third partyGet a customer's, prospect's or supplier's details, by ID, email address or name.
Update third partyChange a third party's details or type.
Validate invoiceValidate a draft invoice, which gives it its number.

Add payment to invoice

Record money received against a validated invoice. Once it's paid in full, Dolibarr marks it paid.

Inputs

InvoiceinvoicetextRequired
The invoice's ID, its number (such as FA2611-0001) or its link.
Payment modepayment_modetextRequired
How the customer paid, such as Credit Transfer or Cheque.
Amountamountnumber
How much was paid. Leave blank for everything left to pay.At least 0.01.
Bank accountbank_accounttext
The account the money went into. Leave blank for the invoice's own account, or your only one.
Payment datedatedate
When it was paid. Leave blank for today.
Referencereferencetext
The payment's reference, such as a transaction ID or cheque number.
Notenotetext
A note on the payment.
Cheque issuercheque_issuertext
For a cheque, who wrote it. Leave blank for the customer's name.

Outputs

amountnumber
How much was recorded
bank_accounttext
The bank account it went into
datetext
The payment date (YYYY-MM-DD)
invoice_idnumber
The invoice's ID
invoice_reftext
The invoice's number
invoice_statustext
The invoice's status now: unpaid, or paid once settled
invoice_totalnumber
The invoice's total with tax
linktext
A link to the invoice in Dolibarr
paidnumber
How much of the invoice is paid now
payment_idnumber
The payment's ID
payment_modetext
How it was paid, such as Credit Transfer
referencetext
Its reference, such as a transaction ID
remainingnumber
How much is left to pay now
Example output
{
  "amount": 216,
  "bank_account": "Main business account",
  "date": "2026-11-06",
  "invoice_id": 41,
  "invoice_ref": "FA2611-0001",
  "invoice_status": "paid",
  "invoice_total": 216,
  "link": "https://erp.example.com/compta/facture/card.php?facid=41",
  "paid": 216,
  "payment_id": 7,
  "payment_mode": "Credit Transfer",
  "reference": "TX-88213",
  "remaining": 0
}

Close proposal

Mark a proposal signed or not signed, such as when the customer accepts or turns it down. A draft is validated first.

Inputs

ProposalproposaltextRequired
The proposal's ID, its number (such as PR2611-0001) or its link.
OutcomeoutcometextRequired
What the customer decided.One of: signed, not_signed (Not signed).
Notenotetext
Why, kept as a private note.

Outputs

currencytext
The currency, such as EUR
customertext
The customer's name
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_reftext
The customer's own reference
datetext
The proposal date (YYYY-MM-DD)
idnumber
The proposal's ID, for other Dolibarr steps
lineslist
Its lines, in order
linktext
A link to it in Dolibarr
note_publictext
The note printed on the proposal
reftext
Its number, such as PR2611-0001; (PROV12) while a draft
statustext
draft, open, signed, not_signed or billed
totalnumber
The total with tax
total_excl_taxnumber
The total before tax
total_taxnumber
The VAT
valid_untiltext
The last day it's valid (YYYY-MM-DD)
Example output
{
  "currency": "EUR",
  "customer": "Acme Corp",
  "customer_email": "billing@acme.example.com",
  "customer_id": 12,
  "customer_ref": "RFQ-77",
  "date": "2026-11-05",
  "id": 9,
  "lines": [
    {
      "description": "Consulting hour",
      "discount_percent": 0,
      "product_id": 1,
      "product_ref": "CONSULT-HOUR",
      "quantity": 2,
      "total": 216,
      "total_excl_tax": 180,
      "unit_price": 90,
      "vat_rate": 20
    }
  ],
  "link": "https://erp.example.com/comm/propal/card.php?id=9",
  "note_public": "",
  "ref": "PR2611-0003",
  "status": "signed",
  "total": 216,
  "total_excl_tax": 180,
  "total_tax": 36,
  "valid_until": "2026-12-05"
}

Create contact

Add a contact person, at a third party or on their own. If one at that third party already has the email address, it's returned instead, unchanged.

Inputs

Last namelast_nametextRequired
Their last name.
First namefirst_nametext
Their first name.
Third partythird_partytext
The company they work at: picked, or its ID, email address or exact name. Leave blank for a contact on their own.
Emailemailtext
Their email address.
Phonephonetext
Their work phone.
Mobilemobiletext
Their mobile phone.
Job titlejob_titletext
Their job title, such as Buyer.

Outputs

createdtrue/false
False when one with that email address was already there
created_attext
When they were added (ISO 8601)
emailtext
Their email address
first_nametext
Their first name
idnumber
The contact's ID
job_titletext
Their job title
last_nametext
Their last name
linktext
A link to them in Dolibarr
mobiletext
Their mobile phone
nametext
Their full name
phonetext
Their work phone
third_partytext
The third party's name
third_party_idnumber
The ID of the third party they're at; 0 if none
Example output
{
  "created": true,
  "created_at": "2026-11-05T09:15:02Z",
  "email": "jane@acme.example.com",
  "first_name": "Jane",
  "id": 31,
  "job_title": "Buyer",
  "last_name": "Doe",
  "link": "https://erp.example.com/contact/card.php?id=31",
  "mobile": "+33 6 00 00 00 02",
  "name": "Jane Doe",
  "phone": "+33 1 00 00 00 01",
  "third_party": "Acme Corp",
  "third_party_id": 12
}

Create invoice

Make a customer invoice with its lines, as a draft or validated with its number.

Inputs

CustomercustomertextRequired
Who it's for: picked, or their ID, email address or exact name.
LineslineslistRequired
One row per line: a product's ref, or a description and a unit price. A product's line takes its price and VAT rate unless the row gives them.
Validatevalidatetrue/false
Validate it straight away, which gives it its number. Otherwise it stays a draft you can change in Dolibarr.Default: false.
Datedatedate
The date it's dated. Leave blank for today.
Customer referencecustomer_reftext
The customer's own reference, such as their order number.
Payment termspayment_termstext
When payment is due, such as 30 days. Leave blank for the customer's own terms.
Payment modepayment_modetext
How the customer is asked to pay, such as Credit Transfer.
Bank accountbank_accounttext
The account the customer pays into, printed on the invoice.
Public notenote_publictext
A note printed on the document for the customer.
Private notenote_privatetext
A note only your team sees.

Outputs

currencytext
The currency, such as EUR
customertext
The customer's name
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_reftext
The customer's own reference, such as their order number
datetext
The invoice date (YYYY-MM-DD)
due_datetext
When payment is due (YYYY-MM-DD)
idnumber
The invoice's ID, for other Dolibarr steps
lineslist
Its lines, in order
linktext
A link to it in Dolibarr
note_privatetext
The private note
note_publictext
The note printed on the invoice
paidnumber
How much has been paid
reftext
Its number, such as FA2611-0001; (PROV12) while a draft
remainingnumber
How much is left to pay
statustext
draft, unpaid, paid or abandoned
totalnumber
The total with tax
total_excl_taxnumber
The total before tax
total_taxnumber
The VAT
typetext
standard, replacement, credit_note or deposit
Example output
{
  "currency": "EUR",
  "customer": "Acme Corp",
  "customer_email": "billing@acme.example.com",
  "customer_id": 12,
  "customer_ref": "PO-1234",
  "date": "2026-11-05",
  "due_date": "2026-12-05",
  "id": 41,
  "lines": [
    {
      "description": "Consulting hour",
      "discount_percent": 0,
      "product_id": 1,
      "product_ref": "CONSULT-HOUR",
      "quantity": 2,
      "total": 216,
      "total_excl_tax": 180,
      "unit_price": 90,
      "vat_rate": 20
    }
  ],
  "link": "https://erp.example.com/compta/facture/card.php?facid=41",
  "note_private": "",
  "note_public": "Thank you for your business.",
  "paid": 0,
  "ref": "FA2611-0001",
  "remaining": 216,
  "status": "unpaid",
  "total": 216,
  "total_excl_tax": 180,
  "total_tax": 36,
  "type": "standard"
}

Create proposal

Make a proposal (a quote) for a customer with its lines, as a draft or validated with its number.

Inputs

CustomercustomertextRequired
Who it's for: picked, or their ID, email address or exact name.
LineslineslistRequired
One row per line: a product's ref, or a description and a unit price. A product's line takes its price and VAT rate unless the row gives them.
Validatevalidatetrue/false
Validate it straight away, which gives it its number, ready to send. Otherwise it stays a draft.Default: false.
Datedatedate
The date it's dated. Leave blank for today.
Valid for (days)valid_daysnumber
How many days the offer stands. Defaults to 30.From 1 to 3650.
Customer referencecustomer_reftext
The customer's own reference, such as their order number.
Payment termspayment_termstext
When payment is due, such as 30 days. Leave blank for the customer's own terms.
Payment modepayment_modetext
How the customer is asked to pay, such as Credit Transfer.
Public notenote_publictext
A note printed on the document for the customer.
Private notenote_privatetext
A note only your team sees.

Outputs

currencytext
The currency, such as EUR
customertext
The customer's name
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_reftext
The customer's own reference
datetext
The proposal date (YYYY-MM-DD)
idnumber
The proposal's ID, for other Dolibarr steps
lineslist
Its lines, in order
linktext
A link to it in Dolibarr
note_publictext
The note printed on the proposal
reftext
Its number, such as PR2611-0001; (PROV12) while a draft
statustext
draft, open, signed, not_signed or billed
totalnumber
The total with tax
total_excl_taxnumber
The total before tax
total_taxnumber
The VAT
valid_untiltext
The last day it's valid (YYYY-MM-DD)
Example output
{
  "currency": "EUR",
  "customer": "Acme Corp",
  "customer_email": "billing@acme.example.com",
  "customer_id": 12,
  "customer_ref": "RFQ-77",
  "date": "2026-11-05",
  "id": 9,
  "lines": [
    {
      "description": "Consulting hour",
      "discount_percent": 0,
      "product_id": 1,
      "product_ref": "CONSULT-HOUR",
      "quantity": 2,
      "total": 216,
      "total_excl_tax": 180,
      "unit_price": 90,
      "vat_rate": 20
    }
  ],
  "link": "https://erp.example.com/comm/propal/card.php?id=9",
  "note_public": "",
  "ref": "PR2611-0003",
  "status": "open",
  "total": 216,
  "total_excl_tax": 180,
  "total_tax": 36,
  "valid_until": "2026-12-05"
}

Create third party

Add a customer, prospect or supplier. If one already has the email address, it's returned instead, unchanged.

Inputs

NamenametextRequired
The company's or person's name.
Typetypetext
What they are to you.One of: customer, prospect, customer_and_prospect (Customer and prospect), supplier, customer_and_supplier (Customer and supplier), other (Neither customer nor supplier). Default: customer.
Emailemailtext
Its email address.
Phonephonetext
Its phone number.
Addressaddresstext
The street address.
Postcodezip_codetext
The postcode or ZIP code.
Towntowntext
The town or city.
Countrycountrytext
The country's two-letter code, such as FR or US, or its name.
Aliasaliastext
Another name it goes by, such as a trading name.
VAT numbervat_numbertext
Its VAT number.
Websitewebsitetext
Its website.
Private notenotetext
A note only your team sees.

Outputs

addresstext
Its street address
aliastext
Its other name, such as a trading name
country_codetext
Its country's two-letter code, such as FR
createdtrue/false
False when one with that email address was already there
created_attext
When it was added (ISO 8601)
customertrue/false
Whether it's a customer
customer_codetext
Its customer code, such as CU2611-00001
emailtext
Its email address
idnumber
The third party's ID, for other Dolibarr steps
linktext
A link to it in Dolibarr
nametext
Its name
notetext
Its private note
opentrue/false
Whether it's open (not closed)
phonetext
Its phone number
prospecttrue/false
Whether it's a prospect
suppliertrue/false
Whether it's a supplier
supplier_codetext
Its supplier code
towntext
Its town
vat_numbertext
Its VAT number
websitetext
Its website
ziptext
Its postcode
Example output
{
  "address": "1 rue de la Paix",
  "alias": "Acme",
  "country_code": "FR",
  "created": true,
  "created_at": "2026-11-05T09:12:44Z",
  "customer": true,
  "customer_code": "CU2611-00012",
  "email": "billing@acme.example.com",
  "id": 12,
  "link": "https://erp.example.com/societe/card.php?socid=12",
  "name": "Acme Corp",
  "note": "",
  "open": true,
  "phone": "+33123456789",
  "prospect": false,
  "supplier": false,
  "supplier_code": "",
  "town": "Paris",
  "vat_number": "FR40303265045",
  "website": "https://acme.example.com",
  "zip": "75002"
}

Download invoice PDF

Save an invoice's PDF as a file in Lodol, to attach to an email or store elsewhere. It's made afresh, with the payments so far.

Inputs

InvoiceinvoicetextRequired
The invoice's ID, its number (such as FA2611-0001) or its link.

Outputs

content_typetext
Its type, application/pdf
document_reftext
The file in Lodol, to pass to a later step
filenametext
The file's name, such as FA2611-0001.pdf
invoice_idnumber
The invoice's ID
reftext
The invoice's number
size_bytesnumber
Its size in bytes
statustext
The invoice's status
urltext
A link to the file in Lodol
Example output
{
  "content_type": "application/pdf",
  "document_ref": "doc_6f1d3c1e58a14c879a4b2f5e",
  "filename": "FA2611-0001.pdf",
  "invoice_id": 41,
  "ref": "FA2611-0001",
  "size_bytes": 9038,
  "status": "unpaid",
  "url": "/actions/core/serve-document/doc_6f1d3c1e58a14c879a4b2f5e?teamId=65f0c0ffee0000000000abcd"
}

Download proposal PDF

Save a proposal's PDF as a file in Lodol, to email to the customer.

Inputs

ProposalproposaltextRequired
The proposal's ID, its number (such as PR2611-0001) or its link.

Outputs

content_typetext
Its type, application/pdf
document_reftext
The file in Lodol, to pass to a later step
filenametext
The file's name, such as FA2611-0001.pdf
proposal_idnumber
The proposal's ID
reftext
The proposal's number
size_bytesnumber
Its size in bytes
statustext
The proposal's status
urltext
A link to the file in Lodol
Example output
{
  "content_type": "application/pdf",
  "document_ref": "doc_6f1d3c1e58a14c879a4b2f5e",
  "filename": "PR2611-0003.pdf",
  "proposal_id": 9,
  "ref": "PR2611-0003",
  "size_bytes": 9038,
  "status": "open",
  "url": "/actions/core/serve-document/doc_6f1d3c1e58a14c879a4b2f5e?teamId=65f0c0ffee0000000000abcd"
}

Find invoices

Find customer invoices by status, customer, number or date, such as every unpaid or overdue one, newest first.

Inputs

Statusstatustext
Which invoices.One of: any, draft, unpaid, paid, abandoned. Default: any.
Customercustomertext
Only this customer's invoices.
Only overdueoverdue_onlytrue/false
Only unpaid invoices past their due date.Default: false.
Number or referencesearchtext
Words in the invoice's number or the customer's reference.
Dated fromdate_fromdate
Only invoices dated on or after this day.
Dated todate_todate
Only invoices dated on or before this day.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

amount_remainingnumber
What is left to pay on the invoices listed, added up
countnumber
How many are listed
invoiceslist
The invoices found, newest first
totalnumber
How many match in all
Example output
{
  "amount_remaining": 216,
  "count": 1,
  "invoices": [
    {
      "currency": "EUR",
      "customer": "Acme Corp",
      "customer_email": "billing@acme.example.com",
      "customer_id": 12,
      "customer_ref": "PO-1234",
      "date": "2026-11-05",
      "due_date": "2026-12-05",
      "id": 41,
      "link": "https://erp.example.com/compta/facture/card.php?facid=41",
      "note_private": "",
      "note_public": "Thank you for your business.",
      "paid": 0,
      "ref": "FA2611-0001",
      "remaining": 216,
      "status": "unpaid",
      "total": 216,
      "total_excl_tax": 180,
      "total_tax": 36,
      "type": "standard"
    }
  ],
  "total": 1
}

Find products

Find products and services by words in their ref, label or barcode, with their price and VAT rate.

Inputs

Searchsearchtext
Words in the ref, label or barcode.
Typetypetext
Products, services or both.One of: any (Products and services), product (Products), service (Services). Default: any.
Only for saleon_sale_onlytrue/false
Leave out those not for sale.Default: false.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
productslist
The products and services found, by ref
totalnumber
How many match in all
Example output
{
  "count": 1,
  "products": [
    {
      "barcode": "",
      "description": "A blue widget",
      "id": 2,
      "label": "Blue widget",
      "link": "https://erp.example.com/product/card.php?id=2",
      "on_purchase": true,
      "on_sale": true,
      "price": 12.5,
      "price_incl_tax": 15,
      "ref": "WIDGET-01",
      "stock": 40,
      "type": "product",
      "vat_rate": 20
    }
  ],
  "total": 1
}

Find third parties

Find customers, prospects and suppliers by words in their name, alias, email or customer code, newest first.

Inputs

Searchsearchtext
Words in the name, alias, email address or customer code.
Emailemailtext
Only those with this email address.
Typetypetext
Which kind of third party.One of: any, customers, prospects, suppliers. Default: any.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
third_partieslist
The third parties found, newest first
totalnumber
How many match in all
Example output
{
  "count": 1,
  "third_parties": [
    {
      "address": "1 rue de la Paix",
      "alias": "Acme",
      "country_code": "FR",
      "created_at": "2026-11-05T09:12:44Z",
      "customer": true,
      "customer_code": "CU2611-00012",
      "email": "billing@acme.example.com",
      "id": 12,
      "link": "https://erp.example.com/societe/card.php?socid=12",
      "name": "Acme Corp",
      "note": "",
      "open": true,
      "phone": "+33123456789",
      "prospect": false,
      "supplier": false,
      "supplier_code": "",
      "town": "Paris",
      "vat_number": "FR40303265045",
      "website": "https://acme.example.com",
      "zip": "75002"
    }
  ],
  "total": 1
}

Get invoice

Get an invoice's details, its lines and the payments made on it.

Inputs

InvoiceinvoicetextRequired
The invoice's ID, its number (such as FA2611-0001) or its link.

Outputs

currencytext
The currency, such as EUR
customertext
The customer's name
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_reftext
The customer's own reference, such as their order number
datetext
The invoice date (YYYY-MM-DD)
due_datetext
When payment is due (YYYY-MM-DD)
idnumber
The invoice's ID, for other Dolibarr steps
lineslist
Its lines, in order
linktext
A link to it in Dolibarr
note_privatetext
The private note
note_publictext
The note printed on the invoice
paidnumber
How much has been paid
paymentslist
The payments made on it
reftext
Its number, such as FA2611-0001; (PROV12) while a draft
remainingnumber
How much is left to pay
statustext
draft, unpaid, paid or abandoned
totalnumber
The total with tax
total_excl_taxnumber
The total before tax
total_taxnumber
The VAT
typetext
standard, replacement, credit_note or deposit
Example output
{
  "currency": "EUR",
  "customer": "Acme Corp",
  "customer_email": "billing@acme.example.com",
  "customer_id": 12,
  "customer_ref": "PO-1234",
  "date": "2026-11-05",
  "due_date": "2026-12-05",
  "id": 41,
  "lines": [
    {
      "description": "Consulting hour",
      "discount_percent": 0,
      "product_id": 1,
      "product_ref": "CONSULT-HOUR",
      "quantity": 2,
      "total": 216,
      "total_excl_tax": 180,
      "unit_price": 90,
      "vat_rate": 20
    }
  ],
  "link": "https://erp.example.com/compta/facture/card.php?facid=41",
  "note_private": "",
  "note_public": "Thank you for your business.",
  "paid": 100,
  "payments": [
    {
      "amount": 100,
      "date": "2026-11-06",
      "payment_mode": "VIR",
      "ref": "PAY2611-0001",
      "reference": "TX-88213"
    }
  ],
  "ref": "FA2611-0001",
  "remaining": 116,
  "status": "unpaid",
  "total": 216,
  "total_excl_tax": 180,
  "total_tax": 36,
  "type": "standard"
}

Get third party

Get a customer's, prospect's or supplier's details, by ID, email address or name.

Inputs

Third partythird_partytextRequired
The third party: picked, or its ID, email address or exact name.

Outputs

addresstext
Its street address
aliastext
Its other name, such as a trading name
country_codetext
Its country's two-letter code, such as FR
created_attext
When it was added (ISO 8601)
customertrue/false
Whether it's a customer
customer_codetext
Its customer code, such as CU2611-00001
emailtext
Its email address
idnumber
The third party's ID, for other Dolibarr steps
linktext
A link to it in Dolibarr
nametext
Its name
notetext
Its private note
opentrue/false
Whether it's open (not closed)
phonetext
Its phone number
prospecttrue/false
Whether it's a prospect
suppliertrue/false
Whether it's a supplier
supplier_codetext
Its supplier code
towntext
Its town
vat_numbertext
Its VAT number
websitetext
Its website
ziptext
Its postcode
Example output
{
  "address": "1 rue de la Paix",
  "alias": "Acme",
  "country_code": "FR",
  "created_at": "2026-11-05T09:12:44Z",
  "customer": true,
  "customer_code": "CU2611-00012",
  "email": "billing@acme.example.com",
  "id": 12,
  "link": "https://erp.example.com/societe/card.php?socid=12",
  "name": "Acme Corp",
  "note": "",
  "open": true,
  "phone": "+33123456789",
  "prospect": false,
  "supplier": false,
  "supplier_code": "",
  "town": "Paris",
  "vat_number": "FR40303265045",
  "website": "https://acme.example.com",
  "zip": "75002"
}

Update third party

Change a third party's details or type. Blank fields stay as they are.

Inputs

Third partythird_partytextRequired
The third party: picked, or its ID, email address or exact name.
Namenametext
A new name. Leave blank to keep it.
Typetypetext
What they are to you now. Leave blank to keep it.One of: customer, prospect, customer_and_prospect (Customer and prospect), supplier, customer_and_supplier (Customer and supplier), other (Neither customer nor supplier).
Emailemailtext
Its email address. Leave blank to keep it.
Phonephonetext
Its phone number. Leave blank to keep it.
Addressaddresstext
The street address. Leave blank to keep it.
Postcodezip_codetext
The postcode or ZIP code. Leave blank to keep it.
Towntowntext
The town or city. Leave blank to keep it.
Countrycountrytext
The country's two-letter code, such as FR or US, or its name. Leave blank to keep it.
Aliasaliastext
Another name it goes by, such as a trading name. Leave blank to keep it.
VAT numbervat_numbertext
Its VAT number. Leave blank to keep it.
Websitewebsitetext
Its website. Leave blank to keep it.
Private notenotetext
A note only your team sees. Replaces the note there. Leave blank to keep it.

Outputs

addresstext
Its street address
aliastext
Its other name, such as a trading name
country_codetext
Its country's two-letter code, such as FR
created_attext
When it was added (ISO 8601)
customertrue/false
Whether it's a customer
customer_codetext
Its customer code, such as CU2611-00001
emailtext
Its email address
idnumber
The third party's ID, for other Dolibarr steps
linktext
A link to it in Dolibarr
nametext
Its name
notetext
Its private note
opentrue/false
Whether it's open (not closed)
phonetext
Its phone number
prospecttrue/false
Whether it's a prospect
suppliertrue/false
Whether it's a supplier
supplier_codetext
Its supplier code
towntext
Its town
vat_numbertext
Its VAT number
websitetext
Its website
ziptext
Its postcode
Example output
{
  "address": "1 rue de la Paix",
  "alias": "Acme",
  "country_code": "FR",
  "created_at": "2026-11-05T09:12:44Z",
  "customer": true,
  "customer_code": "CU2611-00012",
  "email": "billing@acme.example.com",
  "id": 12,
  "link": "https://erp.example.com/societe/card.php?socid=12",
  "name": "Acme Corp",
  "note": "",
  "open": true,
  "phone": "+33123456789",
  "prospect": false,
  "supplier": false,
  "supplier_code": "",
  "town": "Paris",
  "vat_number": "FR40303265045",
  "website": "https://acme.example.com",
  "zip": "75002"
}

Validate invoice

Validate a draft invoice, which gives it its number. It can't be changed after. An invoice already validated is returned as it is.

Inputs

InvoiceinvoicetextRequired
The invoice's ID, its number (such as FA2611-0001) or its link.

Outputs

currencytext
The currency, such as EUR
customertext
The customer's name
customer_emailtext
The customer's email address
customer_idnumber
The customer's ID
customer_reftext
The customer's own reference, such as their order number
datetext
The invoice date (YYYY-MM-DD)
due_datetext
When payment is due (YYYY-MM-DD)
idnumber
The invoice's ID, for other Dolibarr steps
lineslist
Its lines, in order
linktext
A link to it in Dolibarr
note_privatetext
The private note
note_publictext
The note printed on the invoice
paidnumber
How much has been paid
reftext
Its number, such as FA2611-0001; (PROV12) while a draft
remainingnumber
How much is left to pay
statustext
draft, unpaid, paid or abandoned
totalnumber
The total with tax
total_excl_taxnumber
The total before tax
total_taxnumber
The VAT
typetext
standard, replacement, credit_note or deposit
Example output
{
  "currency": "EUR",
  "customer": "Acme Corp",
  "customer_email": "billing@acme.example.com",
  "customer_id": 12,
  "customer_ref": "PO-1234",
  "date": "2026-11-05",
  "due_date": "2026-12-05",
  "id": 41,
  "lines": [
    {
      "description": "Consulting hour",
      "discount_percent": 0,
      "product_id": 1,
      "product_ref": "CONSULT-HOUR",
      "quantity": 2,
      "total": 216,
      "total_excl_tax": 180,
      "unit_price": 90,
      "vat_rate": 20
    }
  ],
  "link": "https://erp.example.com/compta/facture/card.php?facid=41",
  "note_private": "",
  "note_public": "Thank you for your business.",
  "paid": 0,
  "ref": "FA2611-0001",
  "remaining": 216,
  "status": "unpaid",
  "total": 216,
  "total_excl_tax": 180,
  "total_tax": 36,
  "type": "standard"
}

On this page