Finalize invoice

curl --request POST \
  --url https://eu.sequencehq.com/api/invoices/{id}/finalize \
  --header 'Authorization: <authorization>'

import requests

url = "https://eu.sequencehq.com/api/invoices/{id}/finalize"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/invoices/{id}/finalize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.sequencehq.com/api/invoices/{id}/finalize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.sequencehq.com/api/invoices/{id}/finalize"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.sequencehq.com/api/invoices/{id}/finalize")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/invoices/{id}/finalize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV2",
  "dueDate": "2022-11-05",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer@example.com"
  ],
  "customerLegalCompanyName": "Facebook",
  "customerBillingAddress": {
    "line1": "Flat 1",
    "line2": "15 Yemen Road",
    "town": "Yemen",
    "state": "CA",
    "postcode": "YE1 2YE",
    "country": "YE"
  },
  "customerShippingAddress": {
    "line1": "742 Evergreen Terrace",
    "line2": "",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
  "totalTax": "2",
  "netTotal": "12",
  "grossTotal": "10",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "941272d1-f840-4e16-b698-0cd455c81e0e"
  ],
  "linkedServices": [
    {
      "externalId": "ID",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "donald@example.com",
    "taxId": "TAX",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "123456",
      "accountNumber": "12345678"
    },
    "usAchDetails": {
      "accountNumber": "12345678",
      "accountName": "John Doe",
      "bankName": "Chase",
      "bankRoutingNumber": "123456789"
    },
    "usWireDetails": {
      "accountNumber": "12345678",
      "accountName": "John Doe",
      "bankName": "Chase",
      "bankRoutingNumber": "123456789",
      "swiftCode": "CHASUS33",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      }
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "The Merchant"
    },
    "legalCompanyName": "The Merchant",
    "customFields": [],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "accountingDate": "2022-10-05",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "updatedAt": "2022-10-30T00:00:00Z"
}

This response has no body data.

This response has no body data.

This response has no body data.

POST

invoices

{id}

finalize

Finalize invoice

curl --request POST \
  --url https://eu.sequencehq.com/api/invoices/{id}/finalize \
  --header 'Authorization: <authorization>'

import requests

url = "https://eu.sequencehq.com/api/invoices/{id}/finalize"

headers = {"Authorization": "<authorization>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: '<authorization>'}};

fetch('https://eu.sequencehq.com/api/invoices/{id}/finalize', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.sequencehq.com/api/invoices/{id}/finalize",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.sequencehq.com/api/invoices/{id}/finalize"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.sequencehq.com/api/invoices/{id}/finalize")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/invoices/{id}/finalize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "id": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
  "sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV2",
  "dueDate": "2022-11-05",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer@example.com"
  ],
  "customerLegalCompanyName": "Facebook",
  "customerBillingAddress": {
    "line1": "Flat 1",
    "line2": "15 Yemen Road",
    "town": "Yemen",
    "state": "CA",
    "postcode": "YE1 2YE",
    "country": "YE"
  },
  "customerShippingAddress": {
    "line1": "742 Evergreen Terrace",
    "line2": "",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a",
  "totalTax": "2",
  "netTotal": "12",
  "grossTotal": "10",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "941272d1-f840-4e16-b698-0cd455c81e0e"
  ],
  "linkedServices": [
    {
      "externalId": "ID",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "Flat 1",
      "line2": "123 Fake Street",
      "town": "New York",
      "state": "NY",
      "postcode": "AB1 2EF",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "donald@example.com",
    "taxId": "TAX",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "123456",
      "accountNumber": "12345678"
    },
    "usAchDetails": {
      "accountNumber": "12345678",
      "accountName": "John Doe",
      "bankName": "Chase",
      "bankRoutingNumber": "123456789"
    },
    "usWireDetails": {
      "accountNumber": "12345678",
      "accountName": "John Doe",
      "bankName": "Chase",
      "bankRoutingNumber": "123456789",
      "swiftCode": "CHASUS33",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      }
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "The Merchant"
    },
    "legalCompanyName": "The Merchant",
    "customFields": [],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "accountingDate": "2022-10-05",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "updatedAt": "2022-10-30T00:00:00Z"
}

This response has no body data.

This response has no body data.

This response has no body data.

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

sequence-version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

string

required

Invoice Id

Response

string

required

Invoice ID

Example:

"ba37a392-7054-4dae-ab37-6fee9e23fe06"

sequenceAccountId

string

required

Sequence Account ID

Example:

"af9b5988-1d7b-45f6-a188-326df5e59b24"

status

enum<string>

required

Invoice status

Available options:

IN_PROGRESS,

DRAFT,

FINAL,

SENT,

VOIDED

Example:

"SENT"

currency

enum<string>

required

Invoice currency

Available options:

AED,

ARS,

AUD,

BRL,

BGN,

CAD,

CHF,

CLP,

CNY,

COP,

CZK,

DKK,

EGP,

EUR,

GBP,

HKD,

ILS,

INR,

ISK,

JPY,

KRW,

MXN,

NOK,

NZD,

PLN,

SAR,

SEK,

SGD,

THB,

USD,

UYU,

ZAR

Example:

"GBP"

customerEmails

string[]

required

Customer email addresses, used for sending the Invoice if provided

Example:

["customer@example.com"]

customerLegalCompanyName

string

required

Customer's legal company name

Example:

"Facebook"

customerBillingAddress

object

required

Customer's billing address

Show child attributes

Example:

{
  "line1": "Flat 1",
  "line2": "15 Yemen Road",
  "town": "Yemen",
  "state": "CA",
  "postcode": "YE1 2YE",
  "country": "YE"
}

customerShippingAddress

object

required

Customer's billing address

Show child attributes

Example:

{
  "line1": "Flat 1",
  "line2": "15 Yemen Road",
  "town": "Yemen",
  "state": "CA",
  "postcode": "YE1 2YE",
  "country": "YE"
}

customerId

string

required

The ID of the Customer this invoice is linked to

Example:

"b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a"

totalTax

string

required

Total tax, in decimal format of the Invoice's currency

Example:

"2"

netTotal

string

required

Net total, in decimal format of the Invoice's currency

Example:

"12"

grossTotal

string

required

Gross total, in decimal format of the Invoice's currency

Example:

"10"

metadata

object[]

required

Mapping of key-value pairs to attach to the Invoice. These are not interpreted by Sequence; they are present for your use alone.

Show child attributes

Example:

[
  {
    "key": "example-label",
    "value": "label-value"
  }
]

paymentStatus

enum<string>

required

Invoice payment status

Available options:

UNPAID,

PARTIALLY_PAID,

PAID,

UNCOLLECTIBLE

Example:

"UNPAID"

createdAt

string

required

Creation time

Example:

"2022-10-30T00:00:00Z"

creditNoteIds

string[]

required

IDs of linked credit notes (if any)

Example:

["941272d1-f840-4e16-b698-0cd455c81e0e"]

linkedServices

object[]

required

External services which are linked to this invoice

Show child attributes

Example:

[
  {
    "externalId": "ID",
    "externalService": "Xero",
    "syncTime": "2022-06-28T16:47:00Z",
    "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
  }
]

accountingDate

string

required

Accounting date

Example:

"2022-10-05"

renderSettings

object

required

Settings that control how the invoice is rendered.

Show child attributes

Example:

{ "paymentLinkDisplay": "HIDE_PAYMENT_LINK" }

isCustomerArchived

boolean

required

Example:

false

updatedAt

string

required

Last updated time

Example:

"2022-10-30T00:00:00Z"

invoiceNumber

string

Invoice number

Example:

"INV2"

dueDate

string

Due date

Example:

"2022-11-05"

purchaseOrderNumber

string

Purchase order number

Example:

"PO123"

reference

string

Reference

Example:

"ref"

memo

string

Invoice memo

Example:

"Thanks"

paymentOptions

enum<string>[]

Invoice payment options

Available options:

BANK_TRANSFER,

LINK

Example:

["BANK_TRANSFER"]

billingPeriod

object

Billing period

Show child attributes

Example:

{
  "start": "2022-10-01",
  "endInclusive": "2022-10-30"
}

merchantDetails

object

Merchant details

Show child attributes

Example:

{
  "address": {
    "line1": "Flat 1",
    "line2": "123 Fake Street",
    "town": "New York",
    "state": "NY",
    "postcode": "AB1 2EF",
    "country": "US"
  },
  "phoneNumber": "0800001066",
  "email": "donald@example.com",
  "taxId": "TAX",
  "iban": "GB33BUKB20201555555555",
  "ukAccountDetails": {
    "sortCode": "123456",
    "accountNumber": "12345678"
  },
  "usAchDetails": {
    "accountNumber": "12345678",
    "accountName": "John Doe",
    "bankName": "Chase",
    "bankRoutingNumber": "123456789"
  },
  "usWireDetails": {
    "accountNumber": "12345678",
    "accountName": "John Doe",
    "bankName": "Chase",
    "bankRoutingNumber": "123456789",
    "swiftCode": "CHASUS33",
    "bankAddress": {
      "line1": "JP Morgan Chase",
      "town": "New York City",
      "state": "NY",
      "postcode": "10017",
      "country": "US"
    }
  },
  "swedishBankgiroDestination": {
    "bankgiroNumber": "123-4567",
    "accountName": "The Merchant"
  },
  "legalCompanyName": "The Merchant",
  "customFields": [],
  "includeBeneficiaryAddressInPaymentDetails": false
}

customerTaxStatus

enum<string>

Customer tax status

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

Example:

"TAXED"

billingScheduleId

string

Billing Schedule ID

Example:

"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"

issueDate

string

Issue date

Example:

"2022-09-15"

customerTaxId

string

Customer's tax ID

Example:

"TAX123"

creditBalances

string

Credit balances

Example:

"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)"

dunningStatus

enum<string>

Dunning status

Available options:

SCHEDULED,

OVERDUE_CHECK_SCHEDULED,

COMPLETED,

FAILED,

NOT_REQUIRED

Example:

"SCHEDULED"

calculatedAt

string

Time this invoice was last calculated (applicable for invoices generated by billing engine only)

Example:

"2022-09-30T00:00:00Z"

Send invoice

Send a payment reminder for an invoice

⌘I

API Reference

Latest Live API

Version 2024-07-30

Finalize invoice

Headers

Path Parameters

Response