BDL Invoice

API Type

This is a RESTful API, designed for ease of use and integration with modern web applications and services.

The API exchanges data in JSON format.

Authentication

Our API uses Basic Authentication for all requests. Clients must provide a Base64-encoded username and password in the request header.

Endpoints Description

Invoice methods

Request


{
    "statusId": 1,
    "invoiceType": 1,
    "orgId": "string",
    "customerId": "string",
    "invoiceSerial": "string",
    "invoiceNumber": 43,
    "invoiceDate": "2024-09-30",
    "invoiceTotal": 12345,
    "invoiceDue": "7",
    "invoiceCurrency": "Euro",
    "invoiceLanguage": "en",
    "invoiceTemplate": "default",
    "invoiceRow": [
        {"qty": "1", "price": "string", "desc": "string", "vat": "string"},
        {"qty": "1", "price": "string", "desc": "string", "vat": "string"}
    ],
    "invoiceText": "string"
}

Response

{
  "message": "Invoice created successfully.",
  "invoiceId": "12345-67890-abcdef"
}

Response


{
  "success": "Data retrieved successfully",
  "apiData": {
    "org_unique_id": "147fc532-baa111d2-0be269bf",
    "org_name": "Business Digital Layer",
    "org_mode": "2",
    "org_invoices_used": "0",
    "org_invoices_max": "70",
    "org_users_used": "3",
    "org_users_max": "5",
    "org_document_retention": "30",
    "org_start_date": "2023-09-30",
    "org_end_date": "2024-09-30",
    "company_name": "Business Digital Layer S.A.R.L.",
    "company_reg": "91943926500019",
    "company_cif": "FR05919439265",
    "company_country": "France",
    "company_county": "Tarn",
    "company_city": "Albi",
    "company_address": "7 RUE DE LA PORTE NEUVE",
    "company_address_two": "",
    "company_postal_code": "81000",
    "company_vat_type": "1",
    "company_bank": "CR NORD MIDI PYRENEES",
    "company_iban": "FR7611206200010085870844318",
    "company_logo": "logo-white.png",
    "company_notes": "",
    "org_invoice_series": [
        {
            "id_org_prop": "70",
            "org_id": "2",
            "prop_name": "invoice-series",
            "prop_value": "BDL"
        }
    ],
    "org_invoice_number": [
        {
            "id_org_prop": "71",
            "org_id": "2",
            "prop_name": "invoice-number",
            "prop_value": ""
        }
    ],
    "org_draft_series": [
        {
            "id_org_prop": "72",
            "org_id": "2",
            "prop_name": "proforma-series",
            "prop_value": "PBDL"
        }
    ],
    "org_draft_number": [
        {
            "id_org_prop": "73",
            "org_id": "2",
            "prop_name": "proforma-number",
            "prop_value": ""
        }
    ],
    "org_default_vat": [
        {
            "id_org_prop": "78",
            "org_id": "2",
            "prop_name": "invoice-default-vat",
            "prop_value": "20"
        }
    ],
    "org_default_currency": [
        {
            "id_org_prop": "79",
            "org_id": "2",
            "prop_name": "invoice-default-currency",
            "prop_value": "Euro"
        }
    ]
  }
}

Request - optional parameters


{
  "status": number,
  "document_tags_reset": boolean,
  "document_tags": [
    {"tag": "string"},
    {"tag": "string"},
    {"tag": "string"}
  ]
}

Response


{
    "message": "Document updated successfully"
}

Request


{
  "action": delete
}

Response


{
    "success": "Document deleted successfully"
}

Organization methods

Request


{
    "orgName": "Example Organization",
    "orgMaxDocs": 100,
    "orgMaxUsers": 10,
    "orgDocRetention": 30,
    "orgStartDate": "2023-01-01 00:00:00",
    "orgEndDate": "2023-12-31 00:00:00",
    "userFirstName": "John",
    "userLastName": "Doe",
    "userEmail": "john.doe@example.com",
    "userPhone": "123456789",
    "orgInvLangSupport": "en"
}

Response

{
  "message": "Organization created successfully.",
  "orgId": "12345-67890-abcdef"
}

Response


{
    "success": "Data retrieved successfully",
    "apiData": {
        "org_unique_id": "147fc532-baa111d2-0be269bf",
        "org_name": "Business Digital Layer",
        "org_mode": "2",
        "org_invoices_used": "0",
        "org_invoices_max": "70",
        "org_users_used": "3",
        "org_users_max": "5",
        "org_document_retention": "30",
        "org_start_date": "2023-09-30",
        "org_end_date": "2024-09-30",
        "company_name": "Business Digital Layer S.A.R.L.",
        "company_reg": "91943926500019",
        "company_cif": "FR05919439265",
        "company_country": "France",
        "company_county": "Tarn",
        "company_city": "Albi",
        "company_address": "7 RUE DE LA PORTE NEUVE",
        "company_address_two": "",
        "company_postal_code": "81000",
        "company_vat_type": "1",
        "company_bank": "CR NORD MIDI PYRENEES",
        "company_iban": "FR7611206200010085870844318",
        "company_logo": "logo-white.png",
        "company_notes": "",
        "org_invoice_series": "BDL",
        "org_invoice_number": "",
        "org_draft_series": "PBDL",
        "org_draft_number": "",
        "org_default_vat": "20",
        "org_default_currency": "Euro"
    }
}

Customers methods

Request

userType 1 = Company; userType = 2 = Person


{
    "orgId": "string",
    "userType": 0,
    "userFirstName": "string",
    "userLastName": "string",
    "userEmail": "string",
    "userPhone": "string",
    "userCountry": "string",
    "userCity": "string",
    "userCounty": "string",
    "userAddressOne": "string",
    "userAddressTwo": "string",
    "userPostalCode": "string",
    "companyName": "string",
    "companyJ": "string",
    "companyCif": "string"
}

Response

{
  "message": "Customer added successfully",
  "customerId": "12345-67890-abcdef"
}

Response


{
    "success": "Data retrieved successfully",
    "apiData": {
        "customer_id": "1c783615-f46723ec-bd97a2e6",
        "org_id": "147fc532-baa111d2-0be269bf",
        "customer_type": "1",
        "pf_first_name": "",
        "pf_last_name": "",
        "company_name": "BOUTIQUE ABC Inc.",
        "company_reg": "",
        "company_cif": "12345678",
        "company_country": "Canada",
        "company_address": "1155 Rene Levesque Ouest Suite 2500, Montreal, Quebec, H3B 2K4 ",
        "company_address_two": "",
        "company_postal_code": "",
        "company_county": "Quebec",
        "company_city": "Montreal",
        "company_phone": "514-461-0200 x 3",
        "company_email": "office@boutiqueabc.com",
        "company_add_date": "2022-02-03 11:09:59",
        "company_change_date": "2022-11-13 22:43:09"
    }
}

Request


{
  "action": delete
}

Response


{
    "success": "Customer deleted successfully"
}

Acest website folosește cookie-uri

Acest site web folosește cookie-uri pentru a îmbunătăți experiența utilizatorului. Prin utilizarea site-ului nostru web, sunteți de acord cu toate modulele cookie în conformitate cu Politica noastră privind modulele cookie. Learn More

Cookie Declaration

About Cookies

Strict Necesare

Cookie-urile strict necesare permit funcționalitatea de bază a site-ului web, cum ar fi autentificarea utilizatorilor și gestionarea contului. Site-ul web nu poate funcționa corect fără aceste cookie-uri strict necesare.

Cookie report
Nume	Furnizor / Domeniu	Expirare	Descriere
PHPSESSID	PHP.net	Sesiune	Un cookie generat de aplicații bazate pe PHP. Acesta este un identificator de uz general utilizat pentru a menține variabilele sesiunii utilizator. De obicei, este un număr generat aleatoriu, iar utilizarea sa specifică poate varia în funcție de site. Un bun exemplu este menținerea stării de conectare a unui utilizator între pagini.

Afișează cookie-uri

Performanta

Cookie-urile de performanță sunt folosite pentru a vedea modul în care vizitatorii folosesc site-ul web, de exemplu, cookie-uri de analiză. Aceste cookie-uri nu pot fi folosite pentru a identifica direct un anumit vizitator.

Raport Cookie
Nume	Furnizor / Domeniu	Expirare	Descriere
_ga	Google LLC	2 ani	Acest nume cookie este asociat cu Google Universal Analytics, care este o actualizare semnificativă a celui mai utilizat serviciu Google Analytics. Acest cookie este folosit pentru a distinge utilizatorii unici prin atribuirea unui număr generat aleatoriu ca identificator de client. Este inclus în fiecare solicitare de pagină de pe un site și este folosit pentru a calcula datele despre vizitatori, sesiuni și campanii pentru rapoartele de analiză a site-ului.
_gid	Google LLC	1 zi	Acest cookie este setat de Google Analytics. Stochează și actualizează o valoare unică pentru fiecare pagină vizitată și este folosită pentru numărarea și urmărirea vizualizărilor paginii.
_ga_LQYXVB0LDZ		2 ani	Acest cookie este folosit de Google Analytics pentru a persista starea sesiunii.

Afișează cookie-uri

Direcționare

Cookie-urile de direcționare sunt folosite pentru a identifica vizitatorii pe diferite site-uri web, cum ar fi parteneri de conținut, rețele de bannere. Aceste cookie-uri pot fi folosite de companii pentru a construi un profil al intereselor vizitatorilor sau pentru a afișa reclame relevante pe alte site-uri web.

Raport Cookie-uri
Nume	Furnizor / Domeniu	Expirare	Descriere
_gat_gtag_UA_227640127_1		1 minut	Acest cookie face parte din Google Analytics și este folosit pentru a limita solicitările (rata de solicitare de accelerare).

Afișează cookie-uri

Funcționalitate

Cookie-urile de funcționalitate sunt folosite pentru a reține informațiile vizitatorilor de pe site, cum ar fi limba, fusul orar, conținutul îmbunătățit.

Raport Cookie-uri
Nume	Furnizor / Domeniu	Expirare	Descriere

Afișează cookie-uri

Cookie-urile sunt fișiere text mici care sunt plasate pe computerul dvs. de site-urile web pe care le vizitați. Site-urile web folosesc cookie-uri pentru a ajuta utilizatorii să navigheze eficient și să îndeplinească anumite funcții. Cookie-urile necesare pentru ca site-ul web să funcționeze corect pot fi setate fără permisiunea dumneavoastră. Toate celelalte cookie-uri trebuie verificate înainte de a putea fi setate în browserul dumneavoastră. Vă puteți schimba oricând consimțământul pentru utilizarea cookie-urilor pe pagina noastră de Politică de confidențialitate.

Accept all

Refuse all

Save and close

API Documentation v1.0

API Type

Authentication

Endpoints Description

Invoice methods

Request

Response

Response

Request - optional parameters

Response

Request

Response

Organization methods

Request

Response

Response

Customers methods

Request

Response

Response

Request

Response

30 days Free

API Documentation v1.0

API Type

Authentication

Endpoints Description

Invoice methods

POST /api/v1/invoice/send Creates an invoice item

Request

Response

GET /api/v1/invoice/{invoiceId} Returns information about an invoice

Response

PUT /api/v1/invoice/update/{invoiceId} Updates information about an invoice

Request - optional parameters

Response

DELETE /api/v1/invoice/delete/{invoiceId} Deletes an invoice

Request

Response

Organization methods

POST /api/v1/organization/send Creates an organization item

Request

Response

GET /api/v1/organization/{organizationId} Returns information about an organization

Response

Customers methods

POST /api/v1/customer/send Creates a customer for a specific organization

Request

Response

GET /api/v1/customer/{customerId} Returns information about a client

Response

DELETE /api/v1/customer/delete/{customerId} Deletes a client

Request

Response

30 days Free