Introduction

Welcome to Space Invoices API

Space Invoices (SI) is a developer-oriented invoicing API. You can use it to create and manage invoices and various other types of documents, to save time, money and resources, and also to help you refine your commercial software. Furthermore, SI facilitates your management of the data within these documents.

To understand the full scope of our API, please start by taking a look at our documentation. Welcome!

Getting help

We're excited to have you on board and we're here to help you elevate your software solution by being your invoicing API of choice. Always looking to make SI better, let us know if you have a specific challenge you'd like us to help you tackle. Find us at our community Gitter channel: See you soon!

Join our Gitter here.

About

While the API is fully operational and used in production by thousands of organizations every month, we always strive to improve its features. For this reason, we continuously work to update the finer details of this documentation. Features are added regularly, so do check back for updates or sign up for our product update email on our website. We're happy to have you with us, and we look forward to seeing what you can make!

Getting started

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/documents" \
  -H "Authorization: LAUNCH_CODE" \
  -d _documentClient[name]="Rocket Man" \
  -d _documentClient[country]="United Kingdom" \
  -d _documentItems[0][name]="Space suit" \
  -d _documentItems[0][quantity]=2 \
  -d _documentItems[0][unit]="Item" \
  -d _documentItems[0][price]="1000" \
  -d _documentItems[0][_documentItemTaxes][0][rate]=21

curl "https://api.spaceinvoices.com/v1/documents/DOCUMENT_ID/pdf?l=en" \
  -H "Authorization: LAUNCH_CODE" \
  -o my-first-invoice.pdf

Here are some recommended steps to successfully venture into the invoicing universe.

1. Create an Account on Space Invoices

Signup for an account if you haven't already, you'll need it to start making API calls.

It's also recommended to log into Space Invoices as your launch code (access token) will be automatically populated in all documentation examples.

2. Create an Organization

Organizations are the central unit of all other resources in the API, you'll need one to issue invoices.

Space Invoices supports multi-tenant management, meaning an account can have multiple organizations linked to it, each one represents a legal entity like a business, NGO, club, and similar.

3. Create your first invoice

On the right is an API call to create a simple invoice, take it for a spin.

If you're logged into Space Invoices your launch code and organization's ID should already be populated in the example.

4. Fetch a PDF of the invoice you just created

Now let's use the next command to fetch a PDF the invoice, this time you'll need to replace the DOCUMENT_ID in the URL with the actual ID of the created invoice.

Here's an example of how a fully customized invoice PDF might look like.

5. That's it

Great, you now know how to issue invoices!

Read about how to send an invoice to a customer by email.

You can also create and manage organizations for your end customers and issue invoices in their name:

Read about how to create organizations,
and how to grant user access to an organization.

Authentication

# With shell, you can just pass the correct header with each request
curl "https://api.spaceinvoices.com/v1/..."
  -H "Authorization: LAUNCH_CODE"

var spaceInvoices = new SpaceInvoices("LAUNCH_CODE");

<?php
  Spaceinvoices\Spaceinvoices::setAccessToken("LAUNCH_CODE");
?>

Space Invoices uses launch codes to allow access to the API. A launch code can be acquired from our developer dashboard Mission Control.

In headers

The launch code has to be included in all API requests to the server in a header like the following:

Authorization: LAUNCH_CODE

In query params

Alternatively, the launch code can be added as a query parameter of the URL.
Please note this implementation has considerable security risks!

?access_token=LAUNCH_CODE

In documentation

If you are logged into Mission Control the documentation examples will already contain your real launch code.
We recommend creating a non-expiring one through Mission Control for production use.

Errors

Space Invoices API uses the following error codes:

400 Bad Request
Your request is invalid.

401 Unauthorized
You do not have the permission to access the route or are not authorized for the resource with the given ID.

404 Not Found
The specified route could not be found.

422 Unprecessable entity
The provided data is invalid, usually manifesting due to a validation error. Details about the error are visible in the server response body.

500 Internal Server Error
We had a problem with our server. Try again later. This is very rate.

503 Service Unavailable
We're temporarily offline for maintenance. Please try again later. This is very rare.

Filters

# Where
curl "...?filter[where][type]=invoice"
# or
curl "...?filter[where][type][inq]=invoice"

# Include
curl "...?filter[include]=payments"
# or
curl "...?filter[include][tax]=taxRate"

# Fields
curl "...?filter[fields][type]=true"

# Limit
curl "...?filter[limit]=5"

# Order
curl "...?filter[order][date]=ASC"

# Skip
curl "...?filter[skip]=5"

# Deleted
curl "...?filter[deleted]=true"

// Where
var queryParams = {
  filter: {
    where: {
      type: "invoice",
    },
  },
};
// or
var queryParams = {
  filter: {
    where: {
      type: {
        inq: ["invoice", "advance"],
      },
    },
  },
};

// Include
var queryParams = {
  filter: {
    include: "payments",
  },
};
// or
var queryParams = {
  filter: {
    include: {
      tax: "taxRate",
    },
  },
};

// Fields
var queryParams = {
  filter: {
    fields: {
      type: true,
    },
  },
};

// Limit
var queryParams = {
  filter: {
    limit: 5,
  },
};

// Order
var queryParams = {
  filter: {
    order: {
      date: "ASC",
    },
  },
};

// Skip
var queryParams = {
  filter: {
    skip: 5,
  },
};

// Deleted
var queryParams = {
  filter: {
    deleted: true,
  },
};

<?php
  // Where
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "type" => "invoice"
      )
    )
  );

  // or
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "type" => array(
          "inq" => [
            "invoice",
            "advance"
          ]
        )
      )
    )
  );

  // Include
  $queryParams = array(
    "filter" => array(
      "include" => "payments"
  );

  // or
  $queryParams = array(
    "filter" => array(
      "include" => array(
        "tax" => "taxRate"
      )
    )
  );

  // Fields
  $queryParams = array(
    "filter" => array(
      "fields" => array(
        "type" => true
      )
    )
  );

  // Limit
  $queryParams = array(
    "filter" => array(
      "limit" => 5
    )
  );

  // Order
  $queryParams = array(
    "filter" => array(
      "order" => array(
        "date" => "ASC"
      )
    )
  );

  // Skip
  $queryParams = array(
    "filter" => array(
      "skip" => 5
    )
  );

  // Deleted
  $queryParams = array(
    "filter" => array(
      "deleted" => true
    )
  );
?>

Space Invoices API uses a filtering mechanism to control how the data is queried.

where Where query filter.
Accepts operators, see the Where operators section for details.

include
Used to include related models.

fields
Include or exclude certain fields.

limit
Limit the amount of data returned.

order
Order results by property.

skip
The number of results to skip.

deleted Also return deleted records.
Only available on models that implement soft delete.

Where operators

Where operations work in a similar way as querying a database, there operations can be controled with the following:

# Equal
curl "...?filter[where][type]=invoice"

# And / Or
curl "...?filter[where][<and|or>][0]=condition1&?filter[where][<and|or>]condition2"

# GT / GTE
curl "...?filter[where][date][<gt|get>]=2018-04-01T18:30:00.000Z"

# LT / LTE
curl "...?filter[where][date][<lt|lte>]=2018-04-01T18:30:00.000Z"

# Between
curl "...?filter[where][date][between][0]=2018-04-01T18:30:00.000Z&filter[where][date][between][1]=2018-04-01T18:30:00.000Z"

# INQ / NIN
curl "...?filter[where][type][<inq|nin>]=invoice&filter[where][type][<inq|nin>]=estimate"

# Near
curl "...?filter[where][coordinates][near]=153.536,-28.1"
# or
curl "...?filter[where][coordinates][near]=153.536,-28.1&filter[where][coordinates][maxDistance]=5&filter[where][coordinates][unit]=meters"

# NEQ
curl "...?filter[where][draft][neq]=false"

# LIKE / NLIKE / Options
curl "...?filter[where][number][like]=2018.*"
# or
curl "...?filter[where][number][like]=2018.*&filter[where][number][options]=i"

# Regexp
curl "...?filter[where][number][regexp]=^2018"

// Equal
var queryParams = {
  filter: {
    where: {
      type: 'invoice'
    }
  }
}

// And | Or - Instead of and you can also use or
var queryParams = {
  filter: {
    where: {
      and: [{
          type: 'invoice'
        }, {
          draft: false
        }
      ]
    }
  }
}
// GT / GTE
var queryParams = {
  filter: {
    where: {
      date: {
        gt: '2018-04-01T18:30:00.000Z'
      }
    }
  }
}

// LT / LTE
var queryParams = {
  filter: {
    where: {
      date: {
        lt: '2018-04-01T18:30:00.000Z'
      }
    }
  }
}
// Between
var queryParams = {
  filter: {
    where: {
      date: {
        between: [
          '2017-04-01T18:30:00.000Z',
          '2018-04-01T18:30:00.000Z'
        ]
      }
    }
  }
}
// inq / nin
var queryParams = {
  filter: {
    where: {
      type: {
        inq: [
          "invoice",
          "estimate"
        ]
      }
    }
  }
}
// Near
var queryParams = {
  filter: {
    where: {
      coordinates: {
        near: '153.536,-28.1'
      }
    }
  }
}
//or
var queryParams = {
  filter: {
    where: {
      coordinates: {
        near: '153.536,-28.1',
        maxDistance: 5,
        units: 'meters'
      }
    }
  }
}
// NEQ
var queryParams = {
  filter: {
    where: {
      draft: {
        neq: false
      }
    }
  }
}
// LIKE | NLIKE / options
var queryParams = {
  filter: {
    where: {
      number: {
        like: '2018.*'
      }
    }
  }
}
// or
var queryParams = {
  filter: {
    where: {
      number: {
        like: '2018.*'
        options: i
      }
    }
  }
}
// regExp
var queryParams = {
  filter: {
    where: {
      number: {
        regexp: '2018.*'
      }
    }
  }
}

<?php
  // Equal
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "type" => "invoice"
      )
    )
  );

  // And | Or - Instead of and you can also use or
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "and" => [
          array(
            "type" => "invoice"
          ),
          array(
            "draft" => false
          )
        ]
      )
    )
  );

  // GT / GTE
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "date" => array(
          "gt" => "2018-04-01T18:30:00.000Z"
        )
      )
    )
  );

  // LT / LTE
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "date" => array(
          "lt" => "2018-04-01T18:30:00.000Z"
        )
      )
    )
  );

  // Between
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "date" => array(
          "between" => [
            "2017-04-01T18:30:00.000Z",
            "2018-04-01T18:30:00.000Z"
          ]
        )
      )
    )
  );

  // inq / nin
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "type" => array(
          "inq" => [
            "invoice",
            "estimate"
          ]
        )
      )
    )
  );

  // Near
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "coordinates" => array(
          "near" => "153.536,-28.1"
        )
      )
    )
  );

  //or
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "coordinates" => array(
          "near" => "153.536,-28.1",
          "maxDistance" => 5,
          "units" => "meters"
        )
      )
    )
  );

  // NEQ
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "draft" => array(
          "neq" => false
        )
      )
    )
  );

  // LIKE | NLIKE / options
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "number" => array(
          "like" => "2018.*"
        )
      )
    )
  );

  // or
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "number" => array(
          "like" => "2018.*",
          "options" => "i"
        )
      )
    )
  );

  // regExp
  $queryParams = array(
    "filter" => array(
      "where" => array(
        "number" => array(
          "regexp" => "2018.*"
        )
      )
    )
  );
?>

=
Equivalence.

and
Logical AND operator.

or
Logical OR operator.

gt, gte
Numerical greather than (>); greater than of equal (>=).
Valid for the numberical and the date values.
For Geopoint values, the units are in miles by default.

lt, lte
Numerical less than (<); less than or equal (<=).
Valid only for the numerical and the date values.
For Geopoint values, the units are in miles by default.

between
True if the value is between the two specified values: greater than or equal to the first value, and less than or equal to the second value.

inq, nin
In / not in an array of values.

near
For geolocations, return the closest points, sorted in order of distance.
Use with limit to return the n closest points. maxDistance and unit can also be passed on same level as near to configure the search.

neq
Not equal (!=).

like, nlike, options: i
LIKE / NOT LIKE operators for use with regular expressions with the case insensitive flag.

regexp
Regular expression.

Model custom data

{
  ...
  "custom": {
    "string": "String",
    "boolean": true,
    "object": {},
    "number": 42
  }
}

Most models support adding free form custom data, this is achievable through the custom property which is of type object.

Custom property and it's nested data can also be filtered when querying a model endpoint, see filters section for details.

Soft delete

{
  "_isDeleted": true,
  "deletedId": "5a3683ea12d5a67dd0ef2f4c",
  "deletedAt": "2020-04-17 16:40:43.714Z"
}

Indicated models are non-permanently (soft) deleted when performing a delete operation on them.

Soft deleted model instances do not appear in any queries. To retrieve soft deleted instances a deleted property must be added to the filter parameter when querying data, see the filters section for more details.

The deleted property can't be used in the count request.

Smart codes

Smart codes are a mechanism that allows placing codes in some text fields that later get replaced by actual values.
For instance we can place the following text inside a Document's note field:
When paying please use reference [document number]
The [document number] notation will get replaced when creating the Document PDF.

Why does this work better than just using the actual document number?
Imagine creating a copy of the mentioned document by copying its values, this would leave us with a note that contains the invalid document number reference. If we instead use the smart code annotation we don't have to worry about the correct number being populated on each document.

Primarily smart codes are used in document properties note, signature and footer.

Types of smart codes:

Your organization

[organization name]

[IBAN]
Bank account number

[SWIFT]
SWIFT / BIC code of bank

[bank]
Name of bank

[address]

[address2]

[zip]
Zip / postal code

[city]

[country]

[tax number]

[company number]

Document

[document number] Current document number.

Calculations

This section is dedicated to understanding the approach we take when calculating totals on documents.

This section comes in handy when setting up front-end calculations to achieve matching values as on the final created documents.

1. Cut-off

In the first stage, we cut any numbers exceeding the one set on the document itself in the decimalPlaces property, default is 4. No rounding is done.

This goes for values like price, priceGross, quantity and discount (if amount).

Any percent or tax values are always cut to 2 decimal places. This includes properties like discount (if percent) and taxRate.

2. Rounding

After each mathematical operation, we round the result to 2 digits, for example after calculating quantity times price we round using half-up rounding strategy and then use the rounded result in the next operation.

Rate limits

The API has a hard limit of 100 requests/second. Exceeding the limit will throw a 429 status.

The Documents create endpoint has a throttler setup after the limiter to ensure consecutive document numbering. In case of a burst the refresh rate of the limiter is set to 10ms meaning that 100 concurrent calls would resolve in 1000ms minimum not including the processing time for each.

Core resources

Accounts

 POST /v1/accounts
 POST /v1/accounts/login
 POST /v1/accounts/impersonate
  GET /v1/accounts/:id
  GET /v1/accounts/authorized
PATCH /v1/accounts/:id
 POST /v1/accounts/reset
 POST /v1/accounts/reset-password
 POST /v1/accounts/change-password
  GET /v1/accounts/is-unique
  GET /v1/accounts/:id/send-verification
 POST /v1/accountorganizations/accept
 POST /v1/accountorganizations/reject

Accounts represent users that can log in and access different organizations based on the permissions allocated to them.

Space Invoices (root) Account can create new users as child Accounts, a root Account has privileges over those accounts and can manage their access for individual Organizations.

Child accounts can be logged in and controlled by the root account using the impersonate feature.

The Account object

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "password": undefined,
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

Properties

id string readonly
Unique identifier.

email string

password string writeonly

firstname string
User's first name.

lastname string
User's last name.

label string
User's label.
required if fiscally verifying documents.

taxNumber string
User's personal tax number.
required if fiscally verifying documents.

custom object
Custom data.
See Model custom data section for details.

emailVerified boolean readonly
Indicates if email was verified.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Create an Account

curl "https://api.spaceinvoices.com/v1/accounts" \
  -H "Authorization: LAUNCH_CODE" \
  -d email="rocketman@example.com" \
  -d password="supersecret"

spaceInvoices.accounts
  .create({
    email: "rocketman@example.com",
    password: "supersecret",
  })
  .then(function (account) {
    // Use the Account
  });

<?php
  Spaceinvoices\Accounts::create(array(
    "email" => "rocketman@example.com",
    "password" => "supersecret"
  ));
?>

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts

Properties

email string required

password string required

firstname string
User's first name.

lastname string
User's last name.

label string
User's label.
required if fiscally verifying documents.

taxNumber string
User's personal tax number.
required if fiscally verifying documents.

custom object
Custom data.
See Model custom data section for details.

Log in an Account

curl "https://api.spaceinvoices.com/v1/accounts/login" \
  -d email="rocketman@example.com" \
  -d password="supersecret"

spaceInvoices.accounts
  .login({
    email: "rocketman@example.com",
    password: "supersecret",
  })
  .then(function (token) {
    // Use the Access Token
  });

<?php
  Spaceinvoices\Accounts::login(array(
    "email" => "rocketman@example.com",
    "password" => "supersecret"
  ));
?>

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

This endpoint authenticates an Account and returns an Access Token object which includes the launch code that can be used to make authenticated calls to the API.

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts/login

Properties

email string required

password string required

ttl number default 2 months
Time to live.
Determines when the token will expire from time of creation.
To create a non-expiring token use ttl=-1

HTTP Response

Returns an Access Token object.

Properties

id string readonly
Unique identifier.

email string

password string writeonly

firstname string
User's first name.

lastname string
User's last name.

label string
User's label.
required if fiscally verifying documents.

taxNumber string
User's personal tax number.
required if fiscally verifying documents.

custom object
Custom data.
See Model custom data section for details.

emailVerified boolean readonly
Indicates if email was verified.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Impersonate an Account

curl "https://api.spaceinvoices.com/v1/accounts/impersonate" \
  -H "Authorization: LAUNCH_CODE" \
  -d email="rocketman@example.com"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

A root Space Invoices Account can retrieve a launch code for any of their child Accounts using either the child Account's id or email. This functionality is useful for logging in related users without the need of knowing or asking for their login credentials.

Important consideration: Any Account created through the API by a root Account is considered a child of the creator. If a child Account creates another Account, that Account is considered a child of the root Account.

Requires the root Account's launch code in headers or query parameters.

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts/impersonate

Properties

email string
Email of Account to impersonate.
Required if id not provided.

id string
ID of Account to impersonate.
Required if email not provided.

ttl number default 2 months
Time to live.
Determines when the token will expire from time of creation.
To create a non-expiring token use ttl=-1

HTTP Response

Returns an Access Token object for the Account being impersonated.

Properties

id string readonly
Unique identifier.

email string

password string writeonly

firstname string
User's first name.

lastname string
User's last name.

label string
User's label.
required if fiscally verifying documents.

taxNumber string
User's personal tax number.
required if fiscally verifying documents.

custom object
Custom data.
See Model custom data section for details.

emailVerified boolean readonly
Indicates if email was verified.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Retrieve an Account

curl "https://api.spaceinvoices.com/v1/accounts/5e9ab369ed6377000d23d5b5" \
  -H "Authorization: LAUNCH_CODE"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

HTTP Request

GET https://api.spaceinvoices.com/v1/accounts/:id

Route parameters

id string required
ID of the Account being retrieved

Verifying if Account is authorized

curl "https://api.spaceinvoices.com/v1/accounts/authorized" \
  -H "Authorization: LAUNCH_CODE"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "email": "rocketman@example.com",
  "firstname": "",
  "lastname": "",
  "label": "",
  "taxNumber": "",
  "emailVerified": true,
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z",
  "custom": {}
}

Convenience endpoint for verifying a launch code validity or retrieving an Account based on the provided launch code without knowing the Account's ID.

Returns 401 or the authenticated Account's data.

HTTP request

GET https://api.spaceinvoices.com/v1/accounts/authorized

Requesting a password reset token

curl "https://api.spaceinvoices.com/v1/accounts/reset" \
  -d email="rocketman@example.com"

HTTP status 204

The endpoint requests a password reset token which is sent to the email for which the token is requested.

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts/reset

Properties

email string required

Resetting an Account's password

curl "https://api.spaceinvoices.com/v1/accounts/reset-password" \
  -H "Authorization: LAUNCH_CODE"
  -d password="supersecret"

HTTP status 204

A password reset token can be used to change an Account's password if forgotten.

The password reset token retrieved from email must be sent in the headers or query parameters of the request.

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts/reset-password

Properties

password string required

Change an Account's password

curl "https://api.spaceinvoices.com/v1/accounts/change-password" \
  -H "Authorization: LAUNCH_CODE" \
  -d oldPassword="supersecret" \
  -d newPassword="ultimatesecret"

HTTP status 204

HTTP Request

POST https://api.spaceinvoices.com/v1/accounts/change-password

Properties

oldPassword string required

newPassword string required

Check if an email is unique

curl "https://api.spaceinvoices.com/v1/accounts/is-unique?email=rocketman@example.com"

spaceInvoices.accounts
  .isUnique("rocketman@example.com")
  .then(function (response) {
    // Use the response
  });

<?php
  Spaceinvoices\Accounts::isUnique("rocketman@example.com");
?>

{
  "isUnique": true
}

This endpoint returns a boolean value if the email exists in the system already or not.

Please note: Special characters should be URL encoded, otherwise they will be stripped which may cause inaccurate results!

HTTP Request

GET https://api.spaceinvoices.com/v1/accounts/is-unique?email=:email

Route parameters

email string required
Email to verify.

HTTP Response

Properties

isUnique boolean
If the email is unique.

Accepting an invitation

curl "https://api.spaceinvoices.com/v1/accountorganizations/5e9ab369ed6377000d23d5b5/accept" \
  -H "Authorization: LAUNCH_CODE"

HTTP Request

GET https://api.spaceinvoices.com/v1/accountorganizations/:id/accept

Route parameters

id string required
ID of the Access being accepted

{
  "success": true
}

This endpoint allows accepting an open invitation for access to an Organization.

See Organization for more details.

Rejecting an invitation

curl "https://api.spaceinvoices.com/v1/accountorganizations/5e9ab369ed6377000d23d5b5/reject" \
  -H "Authorization: LAUNCH_CODE"

HTTP Request

GET https://api.spaceinvoices.com/v1/accountorganizations/:id/reject

Route parameters

id string required
ID of the Access being rejected

{
  "success": true
}

This endpoint allows rejecting an open invitation for access to an Organization.

See Organization for more details.

Clients

  POST /v1/organizations/:id/clients
   GET /v1/clients/:id
 PATCH /v1/clients/:id
DELETE /v1/clients/:id
   GET /v1/organizations/:id/clients
   GET /v1/organizations/:id/clients/count
   GET /v1/organizations/:id/search-clients

Clients are businesses, end users, organizations, and any other entity that can receive a document from an organization. Clients may be saved and later referenced using their unique ID or email.

The Client object

{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

Properties

id string readonly
Unique identifier.

organizationId string readonly
ID reference to Organization the Client belongs to.

name string
Required only if clientId not provided on Document.

address string
Address.

address2 string
Address additional.

city string
City.

zip string
Zip/postal code.

state string
State or region.

country string
Country.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Client is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.

email string
Contact email.
If provided and clientId not provided will be used to find matching Client to populate clientId.

phone string
Contact phone.

isEndCustomer boolean
Indicates if Client is end customer ie. person.

custom object
Custom data.
See Model custom data section for details.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Create a Client

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/clients" \
  -H "Authorization: LAUNCH_CODE" \
  -d name="Space Exploration Technologies corp" \
  -d address="Rocket Road" \
  -d city="Hawthorne" \
  -d zip="CA 90250" \
  -d country="USA" \
  -d email="info@spacex.com" \
  -d contact="Elon M." \
  -d phone="+1 123 456 7890"

spaceInvoices.clients
  .create("ORG_ID", {
    name: "Space Exploration Technologies corp",
    address: "Rocket Road",
    city: "Hawthorne",
    zip: "CA 90250",
    country: "USA",
    email: "info@spacex.com",
    contact: "Elon M.",
    phone: "+1 123 456 7890",
  })
  .then(function (client) {
    // Use the client
  });

<?php
  Spaceinvoices\Clients::create("ORG_ID", array(
    "name" => "Space Exploration Technologies corp",
    "address" => "Rocket Road",
    "city" => "Hawthorne",
    "zip" => "CA 90250",
    "country" => "USA",
    "email" => "info@spacex.com",
    "contact" => "Elon M.",
    "phone" => "+1 123 456 78900"
  ));
?>

{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

POST https://api.spaceinvoices.com/v1/organizations/:id/clients

Route parameters

id string required
ID of the Organization on which the Client is being created

Properties

name string required
Required only if clientId not provided on Document.

address string
Address.

address2 string
Address additional.

city string
City.

zip string
Zip/postal code.

state string
State or region.

country string
Country.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Client is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.

email string
Contact email.
If provided and clientId not provided will be used to find matching Client to populate clientId.

phone string
Contact phone.

isEndCustomer boolean default false
Indicates if Client is end customer ie. person.

custom object
Custom data.
See Model custom data section for details.

Retrieve a Client

curl "https://api.spaceinvoices.com/v1/clients/5a3683ea12d5a67dd0ef2f4c" \
  -H "Authorization: LAUNCH_CODE"

spaceInvoices.clients.getById(clientId).then(function (client) {
  // Use the client
});

<?php
  Spaceinvoices\Clients::getById("5a3683ea12d5a67dd0ef2f4c");
?>

{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

GET https://api.spaceinvoices.com/v1/clients/:id

Route parameters

id string required
ID of the Client being retrieved

Update a Client

curl -X PATCH "https://api.spaceinvoices.com/v1/clients/5a3683ea12d5a67dd0ef2f4c" \
  -H "Authorization: LAUNCH_CODE" \
  -d name="Space Exploration Technologies corp"

spaceInvoices.clients
  .edit("5a3683ea12d5a67dd0ef2f4c", {
    name: "Space Exploration Technologies corp",
    address: "Rocket Road",
    city: "Hawthorne",
    zip: "CA 90250",
    country: "USA",
    email: "info@spacex.com",
    contact: "Elon M.",
    phone: "+1 123 456 7890",
  })
  .then(function (client) {
    // Use the client
  });

<?php
  Spaceinvoices\Clients::edit("5a3683ea12d5a67dd0ef2f4c", array(
    "name" => "Space Exploration Technologies corp",
    "address" => "Rocket Road",
    "city" => "Hawthorne",
    "zip" => "CA 90250",
    "country" => "USA",
    "email" => "info@spacex.com",
    "contact" => "Elon M.",
    "phone" => "+1 123 456 78900"
  ));
?>

{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

PATCH https://api.spaceinvoices.com/v1/clients/:id

Route parameters

id string required
ID of the Client being updated

Properties

name string
Required only if clientId not provided on Document.

address string
Address.

address2 string
Address additional.

city string
City.

zip string
Zip/postal code.

state string
State or region.

country string
Country.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Client is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.

email string
Contact email.
If provided and clientId not provided will be used to find matching Client to populate clientId.

phone string
Contact phone.

isEndCustomer boolean
Indicates if Client is end customer ie. person.

custom object
Custom data.
See Model custom data section for details.

Delete a Client

curl -X DELETE "https://api.spaceinvoices.com/v1/clients/5a3683ea12d5a67dd0ef2f4c" \
  -H "Authorization: LAUNCH_CODE"

spaceInvoices.clients.delete("5a3683ea12d5a67dd0ef2f4c").then(function (count) {
  // Deleted count
});

<?php
  Spaceinvoices\Clients::delete("5a3683ea12d5a67dd0ef2f4c");
?>

{
  "count": 1
}

HTTP Request

DELETE https://api.spaceinvoices.com/v1/clients/:id

Route parameters

id string required
ID of the Client being deleted

List all Clients

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/clients" \
  -H "Authorization: LAUNCH_CODE"

spaceInvoices.clients.list("ORG_ID").then(function (clients) {
  // Use the clients
});

<?php
  Spaceinvoices\Clients::find("ORG_ID");
?>

[{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}, ...]

HTTP Request

GET https://api.spaceinvoices.com/v1/organizations/:id/clients

Route parameters

id string required
ID of the Organization on which the clients are being listed

filter object
Query filters. See Filters section for more details.

Count all Clients

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/clients/count" \
  -H "Authorization: LAUNCH_CODE"

{
  "count": 1
}

HTTP Request

GET https://api.spaceinvoices.com/v1/organizations/:id/clients/count

Route parameters

id string required
ID of the Organization on which the clients are being counted

where object
Query where. See Where operators section of filters for more details.

Search all Clients

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/clients/search?term=Space" \
  -H "Authorization: LAUNCH_CODE"

spaceInvoices.clients.search("ORG_ID", "space").then(function (clients) {
  // Use the clients
});

<?php
  Spaceinvoices\Clients::search("ORG_ID", "space");
?>

[{
  "id": "5a3683ea12d5a67dd0ef2f4c",
  "organizationId": "5a3683ea12d5a67dd0ef2f4d",
  "name": "Space Exploration Technologies corp",
  "address": "Rocket Road",
  "city": "Hawthorne",
  "zip": "CA 90250",
  "country": "USA",
  "email": "elon@spaceinvoices.com",
  "contact": "Elon M.",
  "phone": "+1 123 456 7890",
  "isEndCustomer": false,
  "companyNumber": null,
  "IBAN": null,
  "bank": null,
  "SWIFT": null,
  "website": null,
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}, ...]

Convenience method for searching client by multiple fields.

HTTP Request

GET https://api.spaceinvoices.com/v1/organizations/:id/clients/search?term=:term

Route parameters

id string required
ID of the Organization on which te clients are being searched

term string required
Term to search for.

Defaults

  POST /v1/organizations/:id/defaults
   GET /v1/defaults/:id
 PATCH /v1/defaults/:id
DELETE /v1/defaults/:id
   GET /v1/organizations/:id/defaults
   GET /v1/organizations/:id/defaults/count

Defaults serve as system-defined and user-defined settings for an Organization.
Besides the predefined system values, any additional value can be added to this model as custom settings.

The defaults are included with the organization model when it is retrieved for ease of use.

The Default object

{
  "id": "5e9ab369ed6377000d23d5b5",
  "name": "currencyId",
  "value": "EUR",
  "organizationId": "5e9e92107f186e000eda09cf",
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

Properties

id string readonly
Unique identifier.

organizationId string readonly
ID reference to Organization the Default belongs to.

name string
Unique name of Default.
Must be unique for each Default in Organization.
Can't be updated.

value any
Value of Default, can be any data type.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Create a Default

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/defaults" \
  -H "Authorization: LAUNCH_CODE" \
  -d name="currencyId" \
  -d value="EUR"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "name": "currencyId",
  "value": "EUR",
  "organizationId": "5e9e92107f186e000eda09cf",
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

POST https://api.spaceinvoices.com/v1/organizations/:id/defaults

Route parameters

id string required
ID of the Organization on which the Default is being created

Properties

name string required
Unique name of Default.
Must be unique for each Default in Organization.
Can't be updated.

value any required
Value of Default, can be any data type.

Retrieve a Default

curl "https://api.spaceinvoices.com/v1/defaults/5e9ab369ed6377000d23d5b5" \
  -H "Authorization: LAUNCH_CODE"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "name": "currencyId",
  "value": "EUR",
  "organizationId": "5e9e92107f186e000eda09cf",
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

GET https://api.spaceinvoices.com/v1/defaults/:id

Route parameters

id string required
ID of the Default being retrieved

Update a Default

curl "https://api.spaceinvoices.com/v1/defaults/5e9ab369ed6377000d23d5b5" \
  -H "Authorization: LAUNCH_CODE" \
  -d value="EUR"

{
  "id": "5e9ab369ed6377000d23d5b5",
  "name": "currencyId",
  "value": "EUR",
  "organizationId": "5e9e92107f186e000eda09cf",
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

PATCH https://api.spaceinvoices.com/v1/defaults/:id

Route parameters

id string required
ID of the Default being updated

Properties

name string
Unique name of Default.
Must be unique for each Default in Organization.
Can't be updated.

value any
Value of Default, can be any data type.

Delete a Default

curl -X DELETE "https://api.spaceinvoices.com/v1/defaults/5e9ab369ed6377000d23d5b5" \
  -H "Authorization: LAUNCH_CODE"

{
  "count": 1
}

HTTP Request

DELETE https://api.spaceinvoices.com/v1/defaults/:id

Route parameters

id string required
ID of the Default being deleted

List all Defaults

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/defaults" \
  -H "Authorization: LAUNCH_CODE"

[{
  "id": "5e9ab369ed6377000d23d5b5",
  "name": "currencyId",
  "value": "EUR",
  "organizationId": "5e9e92107f186e000eda09cf",
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}, ...]

HTTP Request

GET https://api.spaceinvoices.com/v1/organizations/:id/defaults

Route parameters

id string required
ID of the Organization on which the defaults are being listed

filter object
Query filters. See Filters section for more details.

Count all Defaults

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/defaults/count" \
  -H "Authorization: LAUNCH_CODE"

{
  "count": 1
}

HTTP Request

GET https://api.spaceinvoices.com/v1/organizations/:id/defaults/count

Route parameters

id string required
ID of the Organization on which the defaults are being counted

where object
Query where. See Where operators section of filters for more details.

Documents

  POST /v1/organizations/:id/documents
   GET /v1/documents/:id
   PUT /v1/documents/:id
DELETE /v1/documents/:id
   GET /v1/organizations/:id/documents
   GET /v1/organizations/:id/documents/count
   GET /v1/documents/:id/pdf
  POST /v1/documents/:id/send
  POST /v1/documents/:id/cancel
  POST /v1/documents/:id/uncancel
  POST /v1/documents/:id/mark-sent

Documents, the core of our service, are the most complex part of Space Invoices.

For this reason, we have taken a lot of care to provide you with a wide array of options when creating different documents. Most importantly, we allow you to provide as much or as little data as you wish as the API takes care of the rest. The API can automate based on known data such as the organization settings, country of origin, and the country of destination.

NOTE: We have improved how taxes can be loaded to document items. Normally, a tax can be added to document items by adding taxId property to the _documentItems[]._documentItemTaxes array, but the responsibility of knowing tax ids is placed on the user.
To simplify, we now have a feature that allows referencing a tax by its rate or classification instead of just the normal id. The API will then smartly load the best match from the taxes paid for by the organization.

The Document object

{
  "id": "5e9ab369ed6377000d23d5b5",
  "number": "2020-00001",
  "type": "invoice",
  "date": "2020-04-18T07:59:37.902Z",
  "dateDue": "2020-05-18T00:00:00.000Z",
  "dateService": "2020-04-18T07:59:37.902Z",
  "dateServiceTo": "2020-04-18T07:59:37.902Z",
  "dateValidTill": "2020-05-18T00:00:00.000Z",
  "datePaid": "2020-04-18T07:59:37.902Z",
  "reference": "",
  "draft": false,
  "currencyId": "EUR",
  "canceled": false,
  "clientId": "5e9ab369ed6377000d23d5b4",
  "accountId": "5e9ab369ed6377000d23d599",
  "organizationId": "5e9ab369ed6377000d23d59b",
  "_documentClient": {
    "id": "422d1fd5-d8e6-4635-8b16-107679a364f8",
    "name": "Rocket man",
    "country": "United Kingdom",
    "address": undefined,
    "address2": undefined,
    "city": undefined,
    "zip": undefined,
    "state": undefined,
    "taxNumber": undefined,
    "taxSubject": false,
    "companyNumber": undefined,
    "IBAN": undefined,
    "bank": undefined,
    "SWIFT": undefined,
    "website": undefined,
    "email": undefined,
    "phone": undefined,
    "isEndCustomer": false,
    "custom": {}
  },
  "_documentIssuer": {
    "id": "66953056-3253-41e8-9657-59bd9c254dda",
    "name": "International Space Agency",
    "address": "Rocket street 1",
    "address2": "",
    "city": "Brussels",
    "zip": "10000",
    "state": "",
    "country": "Belgium",
    "countryAlpha2Code": "BE",
    "taxNumber": "10489185",
    "taxSubject": true,
    "companyNumber": "0987654321",
    "IBAN": "GB49 REVO 0099 6979 5754 56",
    "bank": "Revolut ltd",
    "SWIFT": "",
    "website": "https://spaceinvoices.com",
    "email": "info@spaceinvoices.com",
    "phone": "+32 466 903 942",
    "custom": {}
  },
  "_documentItems": [
    {
      "id": "8946edb4-946e-4aed-bebd-299b74c3b663",
      "itemId": "5e9a22366d3a80000e8797b0",
      "name": "Space suit",
      "description": "",
      "price": 1000,
      "priceGross": undefined,
      "quantity": 2,
      "discount": 0,
      "discountIsAmount": false,
      "unit": "Item",
      "SKU": undefined,
      "isSeparator": false,
      "total": 2000,
      "totalWithTax": 2420,
      "totalDiscount": 0,
      "totalTax": 420,
      "_documentItemTaxes": [
        {
          "id": "508cae6c-2b28-4607-8a95-9a3066d6077f",
          "taxId": "5e9ac7df1ccbec000de73263",
          "name": "Belasting over de toegevoegde waarde",
          "abbreviation": "BTW",
          "rate": 21,
          "recoverable": true
          "reverseCharged": false,
          "compound": false,
        }
      ],
      "l10n": {},
      "custom": {},
    }
  ],
  "note": "Please pay to bank account GB49 REVO 0099 6979 5754 56.\nWhen paying please use reference 2020-00001.\n\nThank you for your business",
  "signature": "International Space Agency",
  "footer": "International Space Agency, Rocket street 1, 10000 Brussels, Belgium, tax num.: 10489185, company num.: 0987654321",
  "documentIds": [],
  "uniqueId": undefined,
  "decimalPlaces": 4,
  "total": 2000,
  "totalConverted": undefined,
  "totalWithTax": 2420,
  "totalWithTaxConverted": undefined,
  "totalDiscount": 0,
  "totalPaid": 0,
  "totalDue": 2420,
  "paidInFull": false,
  "hasUnit": true,
  "sentSnailMail": false,
  "_documentTaxes": [
    {
      "tax": 21,
      "taxId": "5e9ac7df1ccbec000de73263",
      "base": 2000,
      "totalTax": 420
    }
  ],
  "_documentReverseTaxes": [],
  "_documentConversionRate": [],
  "validateEslog": undefined,
  "isValidEslog": false,
  "l10n": {},
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

Properties

id string readonly
Unique identifier.

organizationId string readonly
ID reference to Organization the Document belongs to.

accountId string readonly
ID reference to Account that created the Document.

number string
Document number.
Must be unique for each Document type in Organization.

type string
Type of document, one of invoice, estimate, advance, credit-note, delivery-note.
Certain Document property rules behave differently depending on document type.
Can't be updated.

date date
Date Document was created/issued.

dateDue date
Date invoice is due.
Auto populated using Organization's default due days invoice_dueDays from today.
Only present if type=invoice.

dateService date
Date the service was started or conducted.
Only present if type=invoice.

dateServiceTo date
The date the service ends if multi-day service.
Only present if type=invoice.

dateValidTill date
Date the estimate is valid until.
Auto populated using Organization's default days valid until estimate_validTillDays from today.
Only present if type=estimate.

datePaid date
Date the advance was paid on.
Only present if type=advance.

reference string
Reference number of document Unique per Document type on Organization. Can be used for payment reference where Document number not in the appropriate format.

draft boolean
If the document is a draft.
If set to false the property cannot go back to true.
Only settable if type=invoice.

currencyId string
ISO 4217 currency code. Wikipedia
If not provided, the Organization's default currency is used.

canceled boolean readonly
Indicates if document is canceled/voided.
See Cancel document section on how to cancel a Document.

clientId string
ID reference to the Organization's Client.
If provided _documentClient object gets populated using referenced Client.

_documentClient object
Document Client data.
Property is optional if clientId is provided.
If populated based on clientId reference any key defined in this object will take precedence.
If clientId is not provided and email is set will attempt to match client in the database based on email. If clientId is not provided, the data in the object is saved to the Organization's Clients, clientId is populated with saved Client.

toggle child attributes

id readonly
Unique nested object identifier.

name string
Name of Client.
Optional if clientId provided on Document.

address string
Address.

address2 string
Address additional.

city string
City.

zip string
Zip/postal code.

state string
State or region.

country string
Country.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Client is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.

email string
Contact email.
If provided and clientId not provided will be used to find matching Client to populate clientId.

phone string
Contact phone.

isEndCustomer boolean
Indicates if Client is end customer ie. person.

custom object
Custom data.
See Model custom data section for details.

_documentIssuer object
Document Issuer data.
Property is automatically populated with Organization data.
Any key that is provided in the object will take precedence, useful for per-document changes.

toggle child attributes

id string readonly
Unique nested object identifier.

name string
Name.

address string

address2 string
Address additional.

city string

zip string
Zip / postal code.

state string
State or region.

country string

countryAlpha2Code string readonly
Country ISO alpha-2 code. Wikipedia. API automatically parses Organization address details to determine the Organization's country and populates property based on the result.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Organization is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.
Displayed on some PDF templates.

email string
Email.
Displayed on some PDF templates.

phone string
Phone.
Displayed on some PDF templates.

custom object
Custom data.
See Model custom data section for details.

_documentItems array
Collection of Document Items.

toggle child attributes

id string readonly
Unique nested object identifier.

itemId string
ID reference to the Organization's item.
If set and property load=true, the item properties are populated from the referenced item, any key provided here will take precedence.

name string
Name of item.
Optional if isSeparator is set to true or if itemId or SKU is provided and load is true.

description
Description of the item.

price number
Price per single item.

priceGross number
Gross price per single item.
If provided price is calculated from it.

quantity number
Quantity of items.

discount number
Discount percent.
If discountIsAmount=true then it is regarded as a value discount instead of percent.

discountIsAmount boolean
Indicates if discount is value based instead of percent.

unit string
Unit of measurement for the item ie. Item, Service, Meter, etc.

SKU string
SKU of the Item, can reference the Organization's Item by SKU property.
If provided and itemId not provided and property load=true, the item properties are populated from the referenced item, any key that is provided will take precedence.

isSepatator boolean
Indicates if item is separator.
Used for visually separating line items and naming groups of line items.
If true all properties except name and description are dropped.

custom object
Custom data.
See Model custom data section for details.

total number readonly
Calculated item sum without tax.

totalWithTax number readonly
Calculated item sum with tax.

totalDiscount number readonly
Calculated item sum discount.

totalTax number readonly
Calculated item sum tax.

_documentItemTaxes object
Collection of Document Item Taxes.

toggle definition

id string readonly
Unique nested object identifier.

taxId string
ID reference to Organization's Tax.
If the property is provided rate, recoverable and compound properties are auto-populated. Note that the rate is chosen based on the date property of Document if Tax has multiple rates associated with it.

name string
Full name of tax.

abbreviation string
Abbreviation of tax, used for display.

rate number
Tax rate percent.
If provided, the API attempts to match the tax from the database and populate it.

classification string
Tax classification.
If provided and rate not provided, the API attempts to match tax by it from the database and populate it.

recoverable boolean
If the tax is recoverable.

reverseCharged boolean
If the tax is reverse (self) charged.
Reverse charged tax is not applied to totals and is added to the Document's reverse taxes.

compound boolean
If tax is compound.
Compound tax is calculated on top of the total with tax sum after other taxes that are applied to the Item.

save boolean unpersisted
If the item should be saved.
If true the item is saved to the Organization's collection of items. The document item is also populated with the item's ID in the itemId field. NOTE: Ignored if itemId is also provided.

l10n object
Content localization.
See Localizing document content section for details.

custom object
Custom data.
See Model custom data section for details.

note string
Note for Document.
Populated with the Organization's default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

signature string
Signature for the Document.
Populated with the Organization default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

footer string
Footer for the Document.
Populated with the Organizaion's default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

l10n object
Content localization.
See Localizing document content section for details.

documentIds array
Collection of IDs of referenced Documents.
Used for stating Document references on PDFs.

uniqueId string
Used to prevent double issuing of the same Document in case of network errors.
Will throw error if Document with same value already exists.

decimalPlaces number
Number of decimal places to which the Document items are trimmed and rounded in calculations.
Should be 4 in most cases.

validateEslog boolean
If the validation for Eslog format should throw an error.

payments array
Collection of related Payments.
Can be included, see Filters section for details. Can be populated on create Document to create Payments as well.

total number readonly
Calculated Document sum without tax.

totalConverted number readonly
The total converted to local currency if the Document in a foreign one.

totalWithTax number readonly
Calculated Document sum with tax.

totalWithTaxConverted string readonly
The totalWithTax converted to local currency if the Document is in a foreign one.

totalDiscount number readonly
Calculated Document sum discount.

totalPaid number readonly
The calculated sum of all added Payments.

totalDue number readonly
The calculated sum of remaining Payments.

paidInFull boolean readonly
If the Document has been paid in full based on added Payments.

hasUnit boolean readonly
If there is at least one Document Item with unit defined.
Used for displaying unit column.

sentSnailMail boolean
If the Document was sent using regular mail.

_documentTaxes array readonly
Collection of Document's unique taxes.

toggle child attributes

tax number
Tax rate percent.

taxId string
ID reference of Tax.

base number
Value base for a given tax calculation.

totalTax number
The total sum of a given tax.

_documentReverseTaxes readonly
Collection Document unique Reverse Taxes.

toggle child attributes

tax number
Tax rate percent.

taxId string
ID reference to Tax.

base number
The value base for a given tax calculation.

totalTax number
The total sum of a given tax.

_documentConversionRate object readonly
Currency conversion rate data.
Property is automatically populated with data if Document currencyId is set to a currency that is not the Organization's default.
Can be manually populated.
Also generates a disclaimer on a generated document PDF.

toggle child attributes

date date
Date of conversion rate data.
Usually the date of document except in cases when the data is not available ie. holidays, then the first available date following.

from string
Currency conversion is made from.

to string
Currency conversion is made into.

rate number
Conversion rate value.

source string
Source of conversion rate data.
ie. European Central Bank.

isValidEslog boolean readonly
If Document has passed Eslog format validation.
Used to determine if output xml file of format is possible.

custom object
Custom data.
See Model custom data section for details.

createdAt date readonly
When the instance was created.

updatedAt date readonly
When the instance was last updated.

Create a Document

curl "https://api.spaceinvoices.com/v1/organizations/ORG_ID/documents" \
  -H "Authorization: LAUNCH_CODE" \
  -d _documentClient[name]="Rocket Man" \
  -d _documentClient[country]="United Kingdom" \
  -d _documentItems[0][name]="Space suit" \
  -d _documentItems[0][quantity]=2 \
  -d _documentItems[0][unit]="Item" \
  -d _documentItems[0][price]="1000" \
  -d _documentItems[0][_documentItemTaxes][0][rate]=21

spaceInvoices.documents
  .create(organization.id, {
    _documentClient: {
      name: "Rocket Man",
      country: "USA",
    },
    _documentItems: [
      {
        name: "Space suit",
        quantity: 2,
        unit: "Item",
        price: 1000,
        _documentItemTaxes: [
          {
            rate: 21,
          },
        ],
      },
    ],
  })
  .then(function (document) {
    // Use the document
  });

<?php
  Spaceinvoices\Documents::create("ORGANIZATION_ID", array(
    "type" => "estimate",
    "_documentClient" => array(
      "name" => "Rocket Man",
      "country" => "United Kingdom"
    ),
    "_documentItems" => [
      array(
        "name" => "Space suit",
        "quantity" => 2,
        "unit" => "Item",
        "price" => 1000,
        "_documentItemTaxes" => [
          array(
            "rate": 21
          )
        ]
      )
    ]
  ));
?>

{
  "id": "5e9ab369ed6377000d23d5b5",
  "number": "2020-00001",
  "type": "invoice",
  "date": "2020-04-18T07:59:37.902Z",
  "dateDue": "2020-05-18T00:00:00.000Z",
  "dateService": "2020-04-18T07:59:37.902Z",
  "dateServiceTo": "2020-04-18T07:59:37.902Z",
  "dateValidTill": "2020-05-18T00:00:00.000Z",
  "datePaid": "2020-04-18T07:59:37.902Z",
  "reference": "",
  "draft": false,
  "currencyId": "EUR",
  "canceled": false,
  "clientId": "5e9ab369ed6377000d23d5b4",
  "accountId": "5e9ab369ed6377000d23d599",
  "organizationId": "5e9ab369ed6377000d23d59b",
  "_documentClient": {
    "id": "422d1fd5-d8e6-4635-8b16-107679a364f8",
    "name": "Rocket man",
    "country": "United Kingdom",
    "taxSubject": false,
    "isEndCustomer": false,
    "custom": {}
  },
  "_documentIssuer": {
    "id": "66953056-3253-41e8-9657-59bd9c254dda",
    "name": "International Space Agency",
    "address": "Rocket street 1",
    "address2": "",
    "city": "Brussels",
    "zip": "10000",
    "state": "",
    "country": "Belgium",
    "countryAlpha2Code": "BE",
    "taxNumber": "10489185",
    "taxSubject": true,
    "companyNumber": "0987654321",
    "IBAN": "GB49 REVO 0099 6979 5754 56",
    "bank": "Revolut ltd",
    "SWIFT": "",
    "website": "https://spaceinvoices.com",
    "email": "info@spaceinvoices.com",
    "phone": "+32 466 903 942",
    "custom": {}
  },
  "_documentItems": [
    {
      "id": "8946edb4-946e-4aed-bebd-299b74c3b663",
      "itemId": "5e9a22366d3a80000e8797b0",
      "name": "Space suit",
      "description": "",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "discountIsAmount": false,
      "unit": "Item",
      "isSeparator": false,
      "total": 2000,
      "totalWithTax": 2420,
      "totalDiscount": 0,
      "totalTax": 420,
      "_documentItemTaxes": [
        {
          "id": "508cae6c-2b28-4607-8a95-9a3066d6077f",
          "taxId": "5e9ac7df1ccbec000de73263",
          "name": "Belasting over de toegevoegde waarde",
          "abbreviation": "BTW",
          "rate": 21,
          "recoverable": true
          "reverseCharged": false,
          "compound": false,
        }
      ],
      "l10n": {},
      "custom": {},
    }
  ],
  "note": "Please pay to bank account GB49 REVO 0099 6979 5754 56.\nWhen paying please use reference 2020-00001.\n\nThank you for your business",
  "signature": "International Space Agency",
  "footer": "International Space Agency, Rocket street 1, 10000 Brussels, Belgium, tax num.: 10489185, company num.: 0987654321",
  "documentIds": [],
  "decimalPlaces": 4,
  "total": 2000,
  "totalWithTax": 2420,
  "totalDiscount": 0,
  "totalPaid": 0,
  "totalDue": 2420,
  "paidInFull": false,
  "hasUnit": true,
  "sentSnailMail": false,
  "_documentTaxes": [
    {
      "tax": 21,
      "taxId": "5e9ac7df1ccbec000de73263",
      "base": 2000,
      "totalTax": 420
    }
  ],
  "_documentReverseTaxes": [],
  "_documentConversionRate": [],
  "isValidEslog": false,
  "l10n": {},
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

This example demonstrates the process of creating an invoice providing minimal data.

HTTP Request

POST https://api.spaceinvoices.com/v1/organizations/:id/documents

Route parameters

id string required
ID of the Organization on which the Document is being created

Properties

number string default YYYY-0000n+1
Document number.
Must be unique for each Document type in Organization.

type string default invoice
Type of document, one of invoice, estimate, advance, credit-note, delivery-note.
Certain Document property rules behave differently depending on document type.
Can't be updated.

date date default today
Date Document was created/issued.

dateDue date default today + default due days
Date invoice is due.
Auto populated using Organization's default due days invoice_dueDays from today.
Only present if type=invoice.

dateService date default today
Date the service was started or conducted.
Only present if type=invoice.

dateServiceTo date
The date the service ends if multi-day service.
Only present if type=invoice.

dateValidTill date default today + default valid till days
Date the estimate is valid until.
Auto populated using Organization's default days valid until estimate_validTillDays from today.
Only present if type=estimate.

datePaid date default today
Date the advance was paid on.
Only present if type=advance.

reference string
Reference number of document Unique per Document type on Organization. Can be used for payment reference where Document number not in the appropriate format.

draft boolean default false
If the document is a draft.
If set to false the property cannot go back to true.
Only settable if type=invoice.

currencyId string
ISO 4217 currency code. Wikipedia
If not provided, the Organization's default currency is used.

clientId string
ID reference to the Organization's Client.
If provided _documentClient object gets populated using referenced Client.

toggle child attributes

name string required
Name of Client.
Optional if clientId provided on Document.

address string
Address.

address2 string
Address additional.

city string
City.

zip string
Zip/postal code.

state string
State or region.

country string
Country.

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Client is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.

email string
Contact email.
If provided and clientId not provided will be used to find matching Client to populate clientId.

phone string
Contact phone.

isEndCustomer boolean default false
Indicates if Client is end customer ie. person.

custom object
Custom data.
See Model custom data section for details.

toggle child attributes

name string
Name.

address string

address2 string
Address additional.

city string

zip string
Zip / postal code.

state string
State or region.

country string

taxNumber string
Organization VAT / GST / sales tax or similar tax number.

taxSubject boolean
Indicates if the Organization is subject to tax.

companyNumber string
Organization registration or similar number.

IBAN string
Bank account number.

bank string
Bank name.

SWIFT string
Bank SWIFT/BIC.

website string
Website address.
Displayed on some PDF templates.

email string
Email.
Displayed on some PDF templates.

phone string
Phone.
Displayed on some PDF templates.

custom object
Custom data.
See Model custom data section for details.

_documentItems array required
Collection of Document Items.

toggle child attributes

itemId string
ID reference to the Organization's item.
If set and property load=true, the item properties are populated from the referenced item, any key provided here will take precedence.

name string required
Name of item.
Optional if isSeparator is set to true or if itemId or SKU is provided and load is true.

description
Description of the item.

price number
Price per single item.

priceGross number
Gross price per single item.
If provided price is calculated from it.

quantity number
Quantity of items.

discount number
Discount percent.
If discountIsAmount=true then it is regarded as a value discount instead of percent.

discountIsAmount boolean default false
Indicates if discount is value based instead of percent.

unit string
Unit of measurement for the item ie. Item, Service, Meter, etc.

isSepatator boolean default false
Indicates if item is separator.
Used for visually separating line items and naming groups of line items.
If true all properties except name and description are dropped.

custom object
Custom data.
See Model custom data section for details.

_documentItemTaxes object
Collection of Document Item Taxes.

toggle definition

name string
Full name of tax.

abbreviation string
Abbreviation of tax, used for display.

rate number
Tax rate percent.
If provided, the API attempts to match the tax from the database and populate it.

classification string
Tax classification.
If provided and rate not provided, the API attempts to match tax by it from the database and populate it.

recoverable boolean
If the tax is recoverable.

reverseCharged boolean
If the tax is reverse (self) charged.
Reverse charged tax is not applied to totals and is added to the Document's reverse taxes.

compound boolean
If tax is compound.
Compound tax is calculated on top of the total with tax sum after other taxes that are applied to the Item.

save boolean unpersisted default false
If the item should be saved.
If true the item is saved to the Organization's collection of items. The document item is also populated with the item's ID in the itemId field. NOTE: Ignored if itemId is also provided.

l10n object
Content localization.
See Localizing document content section for details.

custom object
Custom data.
See Model custom data section for details.

l10n object
Content localization.
See Localizing document content section for details.

documentIds array
Collection of IDs of referenced Documents.
Used for stating Document references on PDFs.

uniqueId string
Used to prevent double issuing of the same Document in case of network errors.
Will throw error if Document with same value already exists.

decimalPlaces number default 4
Number of decimal places to which the Document items are trimmed and rounded in calculations.
Should be 4 in most cases.

validateEslog boolean
If the validation for Eslog format should throw an error.

payments array
Collection of related Payments.
Can be populated on create Document to create Payments as well.

toggle child attributes

type string required
Type of payment, one of bank, online, paypal, cash, card, crypto, coupon, other.

amount number
Payment amount. If not provided the full document amount will be used.

date date
Date of payment.

description string

Retrieve a Document

curl "https://api.spaceinvoices.com/v1/documents/5a3683ea12d5a67dd0ef2f4c" \
  -H "Authorization: LAUNCH_CODE"

spaceInvoices.documents
  .getById(documentId, queryParams)
  .then(function (document) {
    // Use the document
  });

<?php
  Spaceinvoices\Documents::getById("DOCUMENT_ID", $filter);
?>

{
  "id": "5e9ab369ed6377000d23d5b5",
  "number": "2020-00001",
  "type": "invoice",
  "date": "2020-04-18T07:59:37.902Z",
  "dateDue": "2020-05-18T00:00:00.000Z",
  "dateService": "2020-04-18T07:59:37.902Z",
  "dateServiceTo": "2020-04-18T07:59:37.902Z",
  "dateValidTill": "2020-05-18T00:00:00.000Z",
  "datePaid": "2020-04-18T07:59:37.902Z",
  "reference": "",
  "draft": false,
  "currencyId": "EUR",
  "canceled": false,
  "clientId": "5e9ab369ed6377000d23d5b4",
  "accountId": "5e9ab369ed6377000d23d599",
  "organizationId": "5e9ab369ed6377000d23d59b",
  "_documentClient": {
    "id": "422d1fd5-d8e6-4635-8b16-107679a364f8",
    "name": "Rocket man",
    "country": "United Kingdom",
    "taxSubject": false,
    "isEndCustomer": false,
    "custom": {}
  },
  "_documentIssuer": {
    "id": "66953056-3253-41e8-9657-59bd9c254dda",
    "name": "International Space Agency",
    "address": "Rocket street 1",
    "address2": "",
    "city": "Brussels",
    "zip": "10000",
    "state": "",
    "country": "Belgium",
    "countryAlpha2Code": "BE",
    "taxNumber": "10489185",
    "taxSubject": true,
    "companyNumber": "0987654321",
    "IBAN": "GB49 REVO 0099 6979 5754 56",
    "bank": "Revolut ltd",
    "SWIFT": "",
    "website": "https://spaceinvoices.com",
    "email": "info@spaceinvoices.com",
    "phone": "+32 466 903 942",
    "custom": {}
  },
  "_documentItems": [
    {
      "id": "8946edb4-946e-4aed-bebd-299b74c3b663",
      "itemId": "5e9a22366d3a80000e8797b0",
      "name": "Space suit",
      "description": "",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "discountIsAmount": false,
      "unit": "Item",
      "isSeparator": false,
      "total": 2000,
      "totalWithTax": 2420,
      "totalDiscount": 0,
      "totalTax": 420,
      "_documentItemTaxes": [
        {
          "id": "508cae6c-2b28-4607-8a95-9a3066d6077f",
          "taxId": "5e9ac7df1ccbec000de73263",
          "name": "Belasting over de toegevoegde waarde",
          "abbreviation": "BTW",
          "rate": 21,
          "recoverable": true
          "reverseCharged": false,
          "compound": false,
        }
      ],
      "l10n": {},
      "custom": {},
    }
  ],
  "note": "Please pay to bank account GB49 REVO 0099 6979 5754 56.\nWhen paying please use reference 2020-00001.\n\nThank you for your business",
  "signature": "International Space Agency",
  "footer": "International Space Agency, Rocket street 1, 10000 Brussels, Belgium, tax num.: 10489185, company num.: 0987654321",
  "documentIds": [],
  "decimalPlaces": 4,
  "total": 2000,
  "totalWithTax": 2420,
  "totalDiscount": 0,
  "totalPaid": 0,
  "totalDue": 2420,
  "paidInFull": false,
  "hasUnit": true,
  "sentSnailMail": false,
  "_documentTaxes": [
    {
      "tax": 21,
      "taxId": "5e9ac7df1ccbec000de73263",
      "base": 2000,
      "totalTax": 420
    }
  ],
  "_documentReverseTaxes": [],
  "_documentConversionRate": [],
  "isValidEslog": false,
  "l10n": {},
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

HTTP Request

GET https://api.spaceinvoices.com/v1/documents/:id

Route parameters

id string required
ID of the Document being retrieved

parseSmartcodes boolean default true If smart codes should be parsed to their respective values when retrieving the document.

Update a Document

curl -X PUT "https://api.spaceinvoices.com/v1/documents/5a3683ea12d5a67dd0ef2f4c" \
  -H "Authorization: LAUNCH_CODE" \
  -d _documentClient[name]="Rocket Man" \
  -d _documentClient[country]="United Kingdom" \
  -d _documentItems[0][name]="Space suit" \
  -d _documentItems[0][quantity]=2 \
  -d _documentItems[0][unit]="Item" \
  -d _documentItems[0][price]="1000" \
  -d _documentItems[0][_documentItemTaxes][0][rate]=21

spaceInvoices.documents
  .edit(document.id, {...})
  .then(function (document) {
    // Use the document
  });

<?php
  Spaceinvoices\Documents::edit("DOCUMENT_ID", array(...));
?>

{
  "id": "5e9ab369ed6377000d23d5b5",
  "number": "2020-00001",
  "type": "invoice",
  "date": "2020-04-18T07:59:37.902Z",
  "dateDue": "2020-05-18T00:00:00.000Z",
  "dateService": "2020-04-18T07:59:37.902Z",
  "dateServiceTo": "2020-04-18T07:59:37.902Z",
  "dateValidTill": "2020-05-18T00:00:00.000Z",
  "datePaid": "2020-04-18T07:59:37.902Z",
  "reference": "",
  "draft": false,
  "currencyId": "EUR",
  "canceled": false,
  "clientId": "5e9ab369ed6377000d23d5b4",
  "accountId": "5e9ab369ed6377000d23d599",
  "organizationId": "5e9ab369ed6377000d23d59b",
  "_documentClient": {
    "id": "422d1fd5-d8e6-4635-8b16-107679a364f8",
    "name": "Rocket man",
    "country": "United Kingdom",
    "taxSubject": false,
    "isEndCustomer": false,
    "custom": {}
  },
  "_documentIssuer": {
    "id": "66953056-3253-41e8-9657-59bd9c254dda",
    "name": "International Space Agency",
    "address": "Rocket street 1",
    "address2": "",
    "city": "Brussels",
    "zip": "10000",
    "state": "",
    "country": "Belgium",
    "countryAlpha2Code": "BE",
    "taxNumber": "10489185",
    "taxSubject": true,
    "companyNumber": "0987654321",
    "IBAN": "GB49 REVO 0099 6979 5754 56",
    "bank": "Revolut ltd",
    "SWIFT": "",
    "website": "https://spaceinvoices.com",
    "email": "info@spaceinvoices.com",
    "phone": "+32 466 903 942",
    "custom": {}
  },
  "_documentItems": [
    {
      "id": "8946edb4-946e-4aed-bebd-299b74c3b663",
      "itemId": "5e9a22366d3a80000e8797b0",
      "name": "Space suit",
      "description": "",
      "price": 1000,
      "quantity": 2,
      "discount": 0,
      "discountIsAmount": false,
      "unit": "Item",
      "isSeparator": false,
      "total": 2000,
      "totalWithTax": 2420,
      "totalDiscount": 0,
      "totalTax": 420,
      "_documentItemTaxes": [
        {
          "id": "508cae6c-2b28-4607-8a95-9a3066d6077f",
          "taxId": "5e9ac7df1ccbec000de73263",
          "name": "Belasting over de toegevoegde waarde",
          "abbreviation": "BTW",
          "rate": 21,
          "recoverable": true
          "reverseCharged": false,
          "compound": false,
        }
      ],
      "l10n": {},
      "custom": {},
    }
  ],
  "note": "Please pay to bank account GB49 REVO 0099 6979 5754 56.\nWhen paying please use reference 2020-00001.\n\nThank you for your business",
  "signature": "International Space Agency",
  "footer": "International Space Agency, Rocket street 1, 10000 Brussels, Belgium, tax num.: 10489185, company num.: 0987654321",
  "documentIds": [],
  "decimalPlaces": 4,
  "total": 2000,
  "totalWithTax": 2420,
  "totalDiscount": 0,
  "totalPaid": 0,
  "totalDue": 2420,
  "paidInFull": false,
  "hasUnit": true,
  "sentSnailMail": false,
  "_documentTaxes": [
    {
      "tax": 21,
      "taxId": "5e9ac7df1ccbec000de73263",
      "base": 2000,
      "totalTax": 420
    }
  ],
  "_documentReverseTaxes": [],
  "_documentConversionRate": [],
  "isValidEslog": false,
  "l10n": {},
  "custom": {},
  "createdAt": "2020-04-18T07:59:37.938Z",
  "updatedAt": "2020-04-18T07:59:37.938Z"
}

Unlike other models, the Document model performs a full replace when updating instead of a partial update requiring the full object data to be posted.

HTTP Request

PUT https://api.spaceinvoices.com/v1/documents/:id

Route parameters

id string required
ID of the Document being updated