biziq
API docs by Redocly

Biziq API (1.0)

Download OpenAPI specification:Download

Biziq Documentation: [email protected]

Terms conditions and legal terms
Privacy Policy

Overview

The Biziq API is a collection of web services that allow you to receive payments from customers, be notified of those payments, refund them if necessary, among others.

URLs

The API endpoints are available through the following domains:

  • For sandbox environment:
      https://sandboxapi.biziq.app/
  • For production environment:
      https://api.biziq.app/

Authentication

To check your credentials for the API you can go to the API tab on our software.

Server-to-server requests to the API you must be authenticated via Account ID and API Key. If you are associated to more than one company you may also need the Company VAT. To do so, include the following HTTP headers in your API requests:

accountid: <YOUR_ACCOUNT_ID>
apikey: <YOUR_API_KEY>
company_vat: <YOUR_COMPANY_VAT>

When these headers are missing or incorrect, a 401 HTTP status code is returned.

Errors

Biziq uses HTTP response status codes to indicate the success or failure of your API requests. If your request fails, Biziq returns an error using the appropriate status code.

In general, there are three status code ranges you can expect:

  • 2xx success status codes confirm that your request worked as expected
  • 4xx error status codes indicate an error because of the information provided (for example, a required parameter was omitted).
  • 5xx error status codes are rare and indicate an error with Biziq’s servers.

Some 4xx errors that could be handled programmatically include an error code (a short string with a brief explanation) as a value for code.

Below is a list of possible error codes that can be returned, along with additional information about how to resolve them.

Authentication Error

This error can have multiple potential causes. Here are some examples:

  • Missing/Invalid aaccountid and/or apikey Headers
  • Your account has been blocked
  • You don't enough permissions to the action requested

Invalid Content Type Error

This error can only have one cause, you provided an invalid/unsupported content type header.

Invalid JSON Error

This error happens when you provide a bad formated JSON payload.

Invalid Params Error

This error indicates the information provided was incorrect of insufficient (for example, a required parameter was omitted).

Internal Error

This error indicates that an unexpected error ocurred on our servers.

User

This segment outlines various requests that users can execute to effectively manage their personal information within the Biziq platform.

Create User

To successfully create a user, users are only required to furnish the AUTHORIZATIONS parameters.

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
address
string

Use's address

city
string

User's city

country
required
string

User's country

birth_date
string <date>

User's birth date

name
required
string

User's name

email
required
string <email>

User's email

password
required
string

User's password

confirm_password
required
string

Must be equal to password

postal_code
string

User's postal code

Responses

Request samples

Content type
application/json
Example
{
  • "address": "Street 123",
  • "city": "Porto",
  • "birth_date": "1990-01-01",
  • "name": "João Silva",
  • "email": "[email protected]",
  • "password": "senhaSegura123",
  • "confirm_password": "senhaSegura123",
  • "country": "Portugal"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "user": {
    }
}

User Details

To successfully get user's data, users are only required to furnish the AUTHORIZATIONS parameters.

Authorizations:
(accountidapikeycompany_vat)

Responses

Response samples

Content type
application/json
{
  • "response": "success",
  • "user": {
    }
}

Company

This segment provides comprehensive insights and guidelines on leveraging the company settings capabilities of the Biziq API.

Get Company

To successfully get company's data, users are only required to furnish the AUTHORIZATIONS parameters.

Authorizations:
(accountidapikeycompany_vat)

Responses

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Crate Company

To successfully create a Company, users are required to furnish the relevant data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
ask_access
boolean

If the Company already exists, this parameter will help create a request to access the company

address
required
string

Company's address

city
required
string

Company's city

conservatory
string

Company's conservatory

company_type
string

Company's type

country
required
string

Company's country

name
required
string

Company's name

new_services
required
boolean

If you want to receive updates on the services available for your Company

services
required
Array of strings

The Biziq services you want to use in your Company

share_capital
required
number

The Company's share capital

postal_code
required
string

Company's address postal code

vat_number
required
string

Company's VAT Number

Responses

Request samples

Content type
application/json
Example
{
  • "ask_access": true,
  • "address": "Praça Artur Santos Silva 74",
  • "city": "Porto",
  • "conservatory": "Conservatoria Registo Civil do Porto",
  • "company_type": "SA",
  • "country": "Portugal",
  • "name": "Intelidus",
  • "new_services": true,
  • "services": [
    ],
  • "share_capital": 1000,
  • "postal_code": "4200-534",
  • "vat_number": "999111000"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Update Company

To successfully update a Company, users are required to furnish the relevant data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
city
required
string

Company's address city

business_email
required
string

Company's email

postal_code
required
string

Company's address postal code

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Clients

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing Clients under the Invoicing section.

Get Clients

To successfully get company's clients, users are required to furnish the relevant data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
name
string

To search for clients with that name

code
string

To search for clients with that code

Responses

Request samples

Content type
application/json
Example
{
  • "name": "John Doe"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Credit Notes

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing credit notes under the Invoicing section.

Create Credit Note

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
date
string <date>

Date of the Credit Note

name
required
string

Name of the Original Document

serie
required
string

Name of the Series, belonging to the same Company as the Original Document, of the Credit Note type

reason
required
string

Reason why the Credit Note is being created

object

Items present in the Original Document (optional; if not provided, all items available in the Original Document will be used)

Responses

Request samples

Content type
application/json
Example
{
  • "date": "2025-06-25",
  • "name": "FT BETA/000001",
  • "serie": "Serie A",
  • "reason": "Refund",
  • "line_items": {
    }
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Credit Note

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "NC BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Credit Note Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "NC BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

Items

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing items under the Invoicing section.

Get Items

To successfully get company's items, users are required to furnish the relevant data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
code
string

To search for items with that code

type
string
Enum: "Product" "Service" "Other" "ST" "TPC"

To search for item of that type

Responses

Request samples

Content type
application/json
Example
{
  • "code": "ITEM123"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Invoices

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing invoices under the Invoicing section.

Get Summary

To successfully get the invoicing summary, users are required to furnish the relevant data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
period
string
Enum: "today" "week" "month" "between_dates"

Period where the Summary takes place

start_date
string <Y-m-d>

Required if 'period' is 'between_dates'

end_date
string <Y-m-d>

Required if 'period' is 'between_dates'

Responses

Request samples

Content type
application/json
Example
{
  • "period": "month"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Create Invoice

To successfully add a new invoice, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
inv_date
string <Y-m-d>
Default: "Today's date"

Invoice Date

currency
string
Default: "€"

Invoice currency

due
string <Y-m-d>

Invoice due date

generateRefMB
boolean

If you want to generate a MB Reference to the document (only available to invoices)

is_receipt
string
Default: "invoice"

Type of document (invoice, receipt, simplified)

paybylink
boolean

If you want to generate a PayByLink link!

payment_method
string

The invoice payment method

tax_exemption
string

Reason for exemption from fees

recurrence
string

Invoice recurrence

remarks
string

User notes

retention
number

Invoice retention

send_to_client
boolean

Whether the invoice was sent to the client

showIban
boolean

If you want to show Company's IBAN in the document

status
string
Default: "final"

Invoice status (final or draft)

required
object

Client identification number group

required
Array of objects

List of invoice line items

Responses

Request samples

Content type
application/json
Example
{
  • "inv_date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "generateRefMB": true,
  • "is_receipt": "invoice",
  • "paybylink": false,
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "recurrence": "monthly",
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "send_to_client": true,
  • "showIban": true,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Update Invoice

To successfully update a invoice, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
inv_date
string <date>

Invoice Date

currency
string

Invoice currency

due
string <date>

Invoice due date

generateRefMB
boolean

Generate MB reference

is_receipt
string
Enum: "invoice" "receipt" "simplified"

Document type

paybylink
boolean

Generate PayByLink

payment_method
string

Invoice payment method

tax_exemption
string

Reason for tax exemption

recurrence
string

Invoice recurrence

remarks
string

Notes

retention
number

Invoice retention

send_to_client
boolean

Send to client

showIban
boolean

Show IBAN on document

status
string
Enum: "final" "draft"

Document status

required
Array of objects

List of invoice line items

Responses

Request samples

Content type
application/json
Example
{
  • "document_id": 1,
  • "inv_date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "generateRefMB": true,
  • "is_receipt": "invoice",
  • "paybylink": true,
  • "payment_method": "transfer",
  • "tax_exemption": "M01",
  • "recurrence": "monthly",
  • "remarks": "Atualização do documento conforme pedido do cliente.",
  • "retention": 4.5,
  • "send_to_client": true,
  • "showIban": true,
  • "status": "final",
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Invoice

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "FT BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Invoice Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "FT BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

Send Invoices

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
names
required
Array of strings

List of invoice names to send

mail
string <email>

Email to send the Invoice. If not set, it will be sent to the client’s email

Responses

Request samples

Content type
application/json
Example
{}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Mass Import

To successfully import data to mass create invoices, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
query Parameters
company_vat
integer

company VAT number

required
Array of objects

This array can have multiple invoices to be created

Responses

Response samples

Content type
application/json
{
  • "response": "success",
  • "bash_id": "8a005421-77ee-44d3-a84c-cceef66c11a3",
  • "invalid": {
    }
}

Mass Import Status

Returns the status of a mass import operation, including pagination and processing results.

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
hash
required
string

Mass import hash

page
integer >= 1
Default: 1

Page number for pagination

Responses

Request samples

Content type
application/json
{
  • "hash": "abc123xyz",
  • "page": 1
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "queued_count": 0,
  • "done_count": 191,
  • "data": {}
}

Proformas

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing proformas under the Invoicing section.

Create Proforma

To successfully add a new proforma, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
date
string <Y-m-d>
Default: "Today's date"

Proforma Date

currency
string
Default: "€"

Proforma currency

due
string <Y-m-d>

Proforma due date

payment_method
string

The proforma payment method. If it exists it will use the existing one, if it is deactivated it will be activated and if it does not exist it will be created.

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

retention
number

Proforma retention

send_to_client
boolean

Whether the proforma was sent to the client

status
string
Default: "final"

Proforma status (final or draft)

required
object

Client identification number group

required
Array of objects

List of proforma line items

Responses

Request samples

Content type
application/json
Example
{
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Update Proforma

To successfully update a Proforma, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
document_id
required
number

Proforma Identification

date
string <Y-m-d>
Default: "Today's date"

Proforma Date

currency
string
Default: "€"

Proforma currency

due
string <Y-m-d>

Proforma due date

payment_method
string

The proforma payment method. If it exists it will use the existing one, if it is deactivated it will be activated and if it does not exist it will be created.

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

retention
number

Proforma retention

send_to_client
boolean

Whether the proforma was sent to the client

status
string
Default: "final"

Proforma status (final or draft)

required
Array of objects

List of proforma line items

Responses

Request samples

Content type
application/json
Example
{
  • "document_id": 1,
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Proforma

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "PF BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Proforma Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "PF BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

Quotations

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing quotations under the Invoicing section.

Create Quotation

To successfully add a new quotations, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
date
string <Y-m-d>
Default: "Today's date"

Quotation Date

currency
string
Default: "€"

Quotation currency

due
string <Y-m-d>

Quotation due date

payment_method
string

The Quotation payment method. If it exists it will use the existing one, if it is deactivated it will be activated and if it does not exist it will be created.

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

retention
number

Quotation retention

send_to_client
boolean

Whether the Quotation was sent to the client

status
string
Default: "final"

Quotation status (final or draft)

required
object

Client identification number group

required
Array of objects

List of proforma line items

Responses

Request samples

Content type
application/json
Example
{
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Update Quotation

To successfully update a Quotation, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
query Parameters
document_id
required
number

Invoice identification

date
string <Y-m-d>
Default: "Today's date"

Quotation Date

currency
string
Default: "€"

Quotation currency

due
string <Y-m-d>

Quotation due date

payment_method
string

The quotation payment method. If it exists it will use the existing one, if it is deactivated it will be activated and if it does not exist it will be created.

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

retention
number

Quotation retention

send_to_client
boolean

Whether the quotation was sent to the client

status
string
Default: "final"

Quotation status (final or draft)

required
object

List of invoice line items

Request Body schema: application/json
document_id
required
number

Quotation Identification

date
string <Y-m-d>
Default: "Today's date"

Quotation Date

currency
string
Default: "€"

Quotation currency

due
string <Y-m-d>

Quotation due date

payment_method
string

The Quotation payment method. If it exists it will use the existing one, if it is deactivated it will be activated and if it does not exist it will be created.

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

retention
number

Quotation retention

send_to_client
boolean

Whether the Quotation was sent to the client

status
string
Default: "final"

Quotation status (final or draft)

required
Array of objects

List of Quotation line items

Responses

Request samples

Content type
application/json
Example
{
  • "document_id": 1,
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Quotation

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "OR BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Quotation Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "OR BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

Receipts

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing receipts under the Invoicing section.

Create Receipt

To successfully add a new Receipt, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
date
string <Y-m-d>
Default: "Today's date"

Receipt Date

document_id
number

Identifier of the invoice that is going to generate a Receipt

name
required
string

Identifier of the invoice that is going to generate a Receipt

payment_date
string <Y-m-d>
Default: "Today's date"

The date when the payment occurred

payment_method
required
string

Method used in the payment

remarks
string

User notes

send_to_client
boolean

Whether the receipt was sent to the client

status
string
Default: "final"

Receipt status (final or draft)

Responses

Request samples

Content type
application/json
Example
{
  • "date": "2025-06-25",
  • "document_id": 12345,
  • "name": "FT BETA/000001",
  • "payment_date": "2025-06-25",
  • "payment_method": "Credit Card",
  • "remarks": "Pagamento parcial da fatura",
  • "send_to_client": true,
  • "status": "final"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Receipt

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "RG BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Receipt Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "RG BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

Transport Guides

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing transport guides under the Invoicing section.

Create Transport Guide

To successfully add a new Transport Guide, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
charge_date
required
string <Y-m-d>

Charge Date, also know as the date of the beggining of transport, must be equal or after today

charge_hours
required
number

Charge Hours, also know as the hour of the beggining of transport

charge_minutes
required
number

Charge Minutes, also know as the minute of the beggining of transport

charge_address
required
string

Address of where the transport begins

charge_country
required
string

Country of where the transport begins

charge_city
required
string

City of where the transport begins

charge_postal_code
required
string

Postal Code of where the transport begins

date
string <Y-m-d>
Default: "Today's date"

Transport Guide Date

currency
string
Default: "€"

Transport Guide currency

delivery_address
required
string

Address of where the transport ends

delivery_country
required
string

Country of where the transport ends

delivery_city
required
string

City of where the transport ends

delivery_postal_code
required
string

Postal Code of where the transport ends

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

registration
string

Transport Vehicle licence plates

send_to_client
boolean

Whether the Transport Guide was sent to the client

status
string
Default: "final"

Transport Guide status (final or draft)

required
object

Client identification number group

required
Array of objects

List of proforma line items

Responses

Request samples

Content type
application/json
Example
{
  • "charge_date": "2025-06-25",
  • "charge_hours": 10,
  • "charge_minutes": 10,
  • "charge_address": "Street 101",
  • "charge_country": "PT",
  • "charge_city": "Lisbon",
  • "charge_postal_code": "1234-213",
  • "delivery_address": "Street 202",
  • "delivery_country": "PT",
  • "delivery_city": "Lisbon",
  • "delivery_postal_code": "9876-543",
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "client": {
    },
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Update Transport Guide

To successfully update a Transport Guide, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
query Parameters
document_id
required
number

Invoice identification

charge_date
required
string <Y-m-d>

Charge Date, also know as the date of the beggining of transport, must be equal or after today

charge_hours
required
number

Charge Hours, also know as the hour of the beggining of transport

charge_minutes
required
number

Charge Minutes, also know as the minute of the beggining of transport

charge_address
required
string

Address of where the transport begins

charge_city
required
string

City of where the transport begins

charge_postal_code
required
string

Postal Code of where the transport begins

charge_country
required
string

Country of where the transport begins

date
string <Y-m-d>
Default: "Today's date"

Proforma Date

currency
string
Default: "€"

Proforma currency

delivery_address
required
string

Address of where the transport ends

delivery_city
required
string

City of where the transport ends

delivery_postal_code
required
string

Postal Code of where the transport ends

delivery_country
required
string

Country of where the transport ends

delivery_address
required
string

Address of where the transport ends

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

registration
string

Transport Vehicle licence plates

send_to_client
boolean

Whether the transport guide was sent to the client

status
string
Default: "final"

Transport Guide status (final or draft)

required
object

List of invoice line items

Request Body schema: application/json
document_id
required
string

Quotation Identification

charge_date
required
string <Y-m-d>

Charge Date, also know as the date of the beggining of transport, must be equal or after today

charge_hours
required
number

Charge Hours, also know as the hour of the beggining of transport

charge_minutes
required
number

Charge Minutes, also know as the minute of the beggining of transport

charge_address
required
string

Address of where the transport begins

charge_country
required
string

Country of where the transport begins

charge_city
required
string

City of where the transport begins

charge_postal_code
required
string

Postal Code of where the transport begins

date
string <Y-m-d>
Default: "Today's date"

Transport Guide Date

currency
string
Default: "€"

Transport Guide currency

delivery_address
required
string

Address of where the transport ends

delivery_country
required
string

Country of where the transport ends

delivery_city
required
string

City of where the transport ends

delivery_postal_code
required
string

Postal Code of where the transport ends

tax_exemption
string

Reason for exemption from fees

remarks
string

User notes

registration
string

Transport Vehicle licence plates

send_to_client
boolean

Whether the Transport Guide was sent to the client

status
string
Default: "final"

Transport Guide status (final or draft)

required
Array of objects

List of proforma line items

Responses

Request samples

Content type
application/json
Example
{
  • "document_id": 1,
  • "charge_date": "2025-06-25",
  • "charge_hours": 10,
  • "charge_minutes": 10,
  • "charge_address": "Street 101",
  • "charge_country": "PT",
  • "charge_city": "Lisbon",
  • "charge_postal_code": "1234-213",
  • "delivery_address": "Street 202",
  • "delivery_country": "PT",
  • "delivery_city": "Lisbon",
  • "delivery_postal_code": "9876-543",
  • "date": "2025-06-25",
  • "currency": "€",
  • "due": "2025-07-25",
  • "payment_method": "credit_card",
  • "tax_exemption": null,
  • "remarks": "Cliente VIP, pagamento antecipado.",
  • "retention": 3,
  • "status": "final",
  • "line_items": [
    ]
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Transport Guide

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
string

Invoice Identification

document_id
string

Document Identification

Request Body schema: application/json
Any of
name
required
string
document_id
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "GT BETA/000001"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Change Transport Guide Status

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
Any of
name
required
string
document_id
string
status
required
string
cancelation_reason
string

Responses

Request samples

Content type
application/json
Example
{
  • "name": "GT BETA/000001",
  • "status": "canceled",
  • "cancelation_reason": "Client requested cancellation"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Your document was successfully finalized"
}

SAFT

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing SAFT under the Invoicing section.

Get SAFT

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
start_date
required
string <Y-m-d>

Start Date, also know as the date of the beggining of the Billing Period, must be before End Date

end_date
required
string <Y-m-d>

End Date, also know as the date of the conclusion of the Billing Period, must be after Start Date

rebuild
boolean

If you want to build a new XML file.

Responses

Request samples

Content type
application/json
Example
{
  • "start_date": "2025-01-01",
  • "end_date": "2025-01-31",
  • "rebuild": true
}

Response samples

Content type
application/json
{}

Series

This segment provides comprehensive insights and guidelines on leveraging the invoicing capabilities of the Biziq API. Whether you’re initiating transactions, managing financial records, or enhancing your invoicing workflows, this section serves as your go-to resource. Endpoints for managing series under the Invoicing section.

Create Serie

To successfully create a new Serie, users are required to furnish the relevant invoice data within the request body, formatted in JSON. The body parameters integral to this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
name
required
string

Series Name

type
string
Default: "invoice"
Enum: "invoice" "invoice_simplified" "invoice_receipt" "transport_guide" "credit_note" "proforma" "quotation" "receipt"

Type of document the series belongs to

validation_code
string

Only necessary if we don't have communication with Tax Authority

Responses

Request samples

Content type
application/json
{
  • "name": "A001",
  • "type": "invoice",
  • "validation_code": "F23FM4GGBD"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

Get Series

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json

Type of document the series belongs to

type
string
Default: "invoice"
Enum: "invoice" "invoice_simplified" "invoice_receipt" "transport_guide" "credit_note" "proforma" "quotation" "receipt"

Type of document the series belongs to

Responses

Request samples

Content type
application/json
{
  • "type": "invoice"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": {
    }
}

SMS

This segment outlines various requests that users can execute to effectively manage their SMS interactions within the Biziq platform.

Create/Send SMS

In order to dispatch SMS messages, users must provide the necessary data within the request body, formatted in JSON. The essential body parameters for this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
message
required
string

The message that the user intends to send

mobile_num
string

Mobile number of the message recipient

sender
required
string

Identification of the message sender

sms_schedule
string

Schedule for sending the message on a specified day and hour (ISO 8601 format)

blk_Add
string

Enables users to send the same message to multiple numbers

mobile_num_blk
string

Comma-separated list of numbers to send the message to

template_Add
string

Allows the addition of an SMS template

template_name
string

Name of the SMS template

hh
string

Additional hour information

mm
string

Additional minute information

Responses

Request samples

Content type
application/json
Example
{
  • "message": "Hi.",
  • "mobile_num": "912345678",
  • "sender": "MyCompany"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "SMS sent successfully."
}

Sender

This segment outlines various requests that users can execute to effectively manage their SMS interactions within the Biziq platform. Endpoints for managing Senders under the SMS section.

Create Sender

In order to create senders, users must provide the necessary data within the request body, formatted in JSON. The essential body parameters for this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
sender_name
required
string

The sender that the user intends to create

unlimited
boolean

Identifies whether the created sender has an unlimited expiration time

expire_on
string <date>

Expiration date of the sender in format YYYY-MM-DD

Responses

Request samples

Content type
application/json
Example
{
  • "sender_name": "MyCompanySMS",
  • "unlimited": false,
  • "expire_on": "2025-12-31"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Sender create successfully."
}

Template

This segment outlines various requests that users can execute to effectively manage their SMS interactions within the Biziq platform. Endpoints for managing Templates under the SMS section.

Create Template

In order to create templates, users must provide the necessary data within the request body, formatted in JSON. The essential body parameters for this request include:

Authorizations:
(accountidapikeycompany_vat)
query Parameters
name
required
string

The name of the template that the user intends to create

template
required
string

The template that the client intends to create

Request Body schema: application/json
name
required
string

The name of the template that the user intends to create

template
required
string

The template content that the client intends to create

Responses

Request samples

Content type
application/json
{
  • "name": "Summer Promotion",
  • "template": "Hi, enjoy summer promotion with us! Get 20% off on all products. Use code SUMMER20 at checkout."
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Template create successfully."
}

Contacts

This segment outlines various requests that users can execute to effectively manage their SMS interactions within the Biziq platform. Endpoints for managing Contacts under the SMS section.

Create Contacts

In order to create contacts, users must provide the necessary data within the request body, formatted in JSON. The essential body parameters for this request include:

Authorizations:
(accountidapikeycompany_vat)
Request Body schema: application/json
name
required
string

The name the user intends to add to the contact

mobile_number
required
string

Mobile number of the contact

mobile_code_contact
required
string

The country identifier used in the contact to be saved

Responses

Request samples

Content type
application/json
Example
{
  • "name": "João Silva",
  • "mobile_number": "999998888",
  • "mobile_code_contact": "55"
}

Response samples

Content type
application/json
{
  • "response": "success",
  • "message": "Contact successfully created."
}