Billing

All invoices endpoints

Get details of all invoices of a user

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

The filter to search for the description The filter parameter can be used to apply a more specific search, the only element that can be filtered is 'description'. The filter will be done on a part of the provided description (it should contain the searched element). E.g. we need to filter for a string "this is an example" Remember to urlencode the provided filter The final call would look like: /billing/invoice?filter=this%20is%20an%20example

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the invoice

creationDateinteger · integerRead-onlyRequired

The date the invoice was created

dueDateinteger · integerRead-onlyRequired

The due date of the invoice

invoiceNumberstringRead-onlyRequired

The number of the invoice

invoiceHashstringRead-onlyRequired

A unique hash for this invoice

descriptionstringRequired

The description of the invoice

currencystringRequired

The currency that is being used

currencySignstringRequired

The currency sign that is being used

amountIncVATstringRequired

The amount of the invoice with VAT in cents

amountExclVATstringRequired

The amount of the invoice without VAT in cents

paymentStatusinteger · integerRequired

The payment status

paymentDateinteger · integerRequired

The timestamp that the invoice was paid, if paid

isCreditinteger · integerRequired

If this field is 1 it means that invoice is a credit invoice

remainingAmountstringRequired

The remaining amount of invoice

totalPaidAmountstringRequired

The total paid amount of invoice

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/account/invoice

HTTPcURLJavaScriptPython

GET /v3/account/invoice HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "creationDate": 1,
    "dueDate": 1,
    "invoiceNumber": "text",
    "invoiceHash": "text",
    "description": "text",
    "currency": "text",
    "currencySign": "text",
    "amountIncVAT": "text",
    "amountExclVAT": "text",
    "paymentStatus": 1,
    "paymentDate": 1,
    "isCredit": 1,
    "remainingAmount": "text",
    "totalPaidAmount": "text"
  }
]

Get details of all unpaid invoices for a user (excluding credit invoices)

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Query parameters

filterstringOptional

The filter to search for the description The filter parameter can be used to apply a more specific search, the only element that can be filtered is 'description'. The filter will be done on a part of the provided description (it should contain the searched element). E.g. we need to filter for a string "this is an example" Remember to urlencode the provided filter The final call would look like: /billing/invoice?filter=this%20is%20an%20example

Header parameters

RANGED-DATAstringOptional

Example header and default range: RANGED-DATA:start=0,results=25

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the invoice

creationDateinteger · integerRead-onlyRequired

The date the invoice was created

dueDateinteger · integerRead-onlyRequired

The due date of the invoice

invoiceNumberstringRead-onlyRequired

The number of the invoice

invoiceHashstringRead-onlyRequired

A unique hash for this invoice

descriptionstringRequired

The description of the invoice

currencystringRequired

The currency that is being used

currencySignstringRequired

The currency sign that is being used

amountIncVATstringRequired

The amount of the invoice with VAT in cents

amountExclVATstringRequired

The amount of the invoice without VAT in cents

paymentStatusinteger · integerRequired

The payment status

paymentDateinteger · integerRequired

The timestamp that the invoice was paid, if paid

isCreditinteger · integerRequired

If this field is 1 it means that invoice is a credit invoice

remainingAmountstringRequired

The remaining amount of invoice

totalPaidAmountstringRequired

The total paid amount of invoice

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/account/invoice/unpaid

HTTPcURLJavaScriptPython

GET /v3/account/invoice/unpaid HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "creationDate": 1,
    "dueDate": 1,
    "invoiceNumber": "text",
    "invoiceHash": "text",
    "description": "text",
    "currency": "text",
    "currencySign": "text",
    "amountIncVAT": "text",
    "amountExclVAT": "text",
    "paymentStatus": 1,
    "paymentDate": 1,
    "isCredit": 1,
    "remainingAmount": "text",
    "totalPaidAmount": "text"
  }
]

Get invoice details by invoice ID

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

invoiceIdintegerRequired

ID of the invoice to fetch details about

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

The ID of the invoice

invoiceNumberstringRead-onlyRequired

Invoice number

invoiceHashstringRead-onlyRequired

A unique hash for this invoice

clientNumberstringRead-onlyRequired

Client number

creationDatestringRead-onlyRequired

The date the invoice was created

dueDatestringRead-onlyRequired

The due date of the invoice

paymentStatusinteger · integerRead-onlyRequired

Whether or not the invoice was paid

paymentDateinteger · integerRequired

The timestamp that the invoice was paid, if paid

isCreditinteger · integerRequired

If this field is 1 it means that invoice is a credit invoice

paymentTerminteger · integerRead-onlyRequired

The invoice must be paid in the given amount of time (days)

currencystringRead-onlyRequired

The name of the currency that is being used

currencySignstringRead-onlyRequired

The sign of the currency that is being used

vatPercentageinteger · integerRead-onlyRequired

Percentage of VAT applied

vatAmountstringRead-onlyRequired

Amount of VAT to pay in cents

amountIncVatstringRead-onlyRequired

The amount of the invoice with VAT included in cents

amountExclVatstringRead-onlyRequired

The amount of the invoice without VAT in cents

403

Invalid credentials

404

Invalid invoice ID

500

Internal Server Error

application/json

get

/v3/account/invoice/{invoiceId}

HTTPcURLJavaScriptPython

GET /v3/account/invoice/{invoiceId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "invoiceNumber": "text",
    "invoiceHash": "text",
    "clientNumber": "text",
    "creationDate": "text",
    "dueDate": "text",
    "paymentStatus": 1,
    "paymentDate": 1,
    "isCredit": 1,
    "paymentTerm": 1,
    "currency": "text",
    "currencySign": "text",
    "vatPercentage": 1,
    "vatAmount": "text",
    "amountIncVat": "text",
    "amountExclVat": "text",
    "items": [
      {
        "orderId": "text",
        "description": "text",
        "periodFrom": "text",
        "periodTo": "text",
        "remarks": "text",
        "quantity": 1,
        "setupCosts": "text",
        "unitPrice": "text",
        "vatPercentage": 1,
        "vatAmount": "text",
        "amountIncVat": "text",
        "amountExclVat": "text"
      }
    ],
    "clientDetails": {
      "fullName": "text",
      "companyName": "text",
      "email": "text",
      "address": "text",
      "zip": "text",
      "city": "text",
      "country": "text",
      "vatNumber": "text",
      "iban": "text",
      "bic": "text"
    },
    "companyDetails": {
      "name": "text",
      "address": "text",
      "zip": "text",
      "city": "text",
      "country": "text",
      "phone": "text",
      "email": "text",
      "url": "text",
      "iban": "text",
      "bic": "text"
    }
  }
]

Get invoice details by invoice number

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

invoiceNumberstringRequired

Number of the invoice to fetch details about

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

The ID of the invoice

invoiceNumberstringRead-onlyRequired

Invoice number

invoiceHashstringRead-onlyRequired

A unique hash for this invoice

clientNumberstringRead-onlyRequired

Client number

creationDatestringRead-onlyRequired

The date the invoice was created

dueDatestringRead-onlyRequired

The due date of the invoice

paymentStatusinteger · integerRead-onlyRequired

Whether or not the invoice was paid

paymentDateinteger · integerRequired

The timestamp that the invoice was paid, if paid

isCreditinteger · integerRequired

If this field is 1 it means that invoice is a credit invoice

paymentTerminteger · integerRead-onlyRequired

The invoice must be paid in the given amount of time (days)

currencystringRead-onlyRequired

The name of the currency that is being used

currencySignstringRead-onlyRequired

The sign of the currency that is being used

vatPercentageinteger · integerRead-onlyRequired

Percentage of VAT applied

vatAmountstringRead-onlyRequired

Amount of VAT to pay in cents

amountIncVatstringRead-onlyRequired

The amount of the invoice with VAT included in cents

amountExclVatstringRead-onlyRequired

The amount of the invoice without VAT in cents

403

Invalid credentials

404

Invalid invoice number

500

Internal Server Error

application/json

get

/v3/account/invoice/number/{invoiceNumber}

HTTPcURLJavaScriptPython

GET /v3/account/invoice/number/{invoiceNumber} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "invoiceNumber": "text",
    "invoiceHash": "text",
    "clientNumber": "text",
    "creationDate": "text",
    "dueDate": "text",
    "paymentStatus": 1,
    "paymentDate": 1,
    "isCredit": 1,
    "paymentTerm": 1,
    "currency": "text",
    "currencySign": "text",
    "vatPercentage": 1,
    "vatAmount": "text",
    "amountIncVat": "text",
    "amountExclVat": "text",
    "items": [
      {
        "orderId": "text",
        "description": "text",
        "periodFrom": "text",
        "periodTo": "text",
        "remarks": "text",
        "quantity": 1,
        "setupCosts": "text",
        "unitPrice": "text",
        "vatPercentage": 1,
        "vatAmount": "text",
        "amountIncVat": "text",
        "amountExclVat": "text"
      }
    ],
    "clientDetails": {
      "fullName": "text",
      "companyName": "text",
      "email": "text",
      "address": "text",
      "zip": "text",
      "city": "text",
      "country": "text",
      "vatNumber": "text",
      "iban": "text",
      "bic": "text"
    },
    "companyDetails": {
      "name": "text",
      "address": "text",
      "zip": "text",
      "city": "text",
      "country": "text",
      "phone": "text",
      "email": "text",
      "url": "text",
      "iban": "text",
      "bic": "text"
    }
  }
]

Get invoice as PDF

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

invoiceIdintegerRequired

ID of the invoice to fetch details about

Responses

200

OK

application/pdf

string · binaryOptional

403

Invalid credentials

404

Invalid invoice ID

500

Internal Server Error

application/jsonapplication/pdf

get

/v3/account/invoice/{invoiceId}/pdf

HTTPcURLJavaScriptPython

GET /v3/account/invoice/{invoiceId}/pdf HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

binary