Create an invoice

curl --request POST \
  --url https://eu.sequencehq.com/api/invoices \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "currency": "GBP",
  "dueDate": "2022-09-30",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@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",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
  "accountingDate": "2022-09-30",
  "attachmentAssetIds": [
    "99874519-25ce-46ff-8823-093115aa7222"
  ]
}
'

import requests

url = "https://eu.sequencehq.com/api/invoices"

payload = {
    "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
    "currency": "GBP",
    "dueDate": "2022-09-30",
    "purchaseOrderNumber": "PO123",
    "reference": "ref",
    "customerEmails": ["customer.user.a@example.com", "customer.user.b@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",
        "town": "Springfield",
        "state": "CA",
        "postcode": "12345",
        "country": "US"
    },
    "memo": "Thanks",
    "paymentOptions": ["BANK_TRANSFER"],
    "billingPeriod": {
        "start": "2022-10-01",
        "endInclusive": "2022-10-30"
    },
    "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
    "metadata": [
        {
            "key": "example-label",
            "value": "label-value"
        }
    ],
    "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
    "billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
    "accountingDate": "2022-09-30",
    "attachmentAssetIds": ["99874519-25ce-46ff-8823-093115aa7222"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingScheduleId: 'fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95',
    currency: 'GBP',
    dueDate: '2022-09-30',
    purchaseOrderNumber: 'PO123',
    reference: 'ref',
    customerEmails: ['customer.user.a@example.com', 'customer.user.b@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',
      town: 'Springfield',
      state: 'CA',
      postcode: '12345',
      country: 'US'
    },
    memo: 'Thanks',
    paymentOptions: ['BANK_TRANSFER'],
    billingPeriod: {start: '2022-10-01', endInclusive: '2022-10-30'},
    customerId: '61b083e0-1faa-47ca-9aeb-6205da8f6c47',
    metadata: [{key: 'example-label', value: 'label-value'}],
    creditBalances: 'Verification 2 credit balance: 7/7 (expiring on 4 May 2023)',
    billingRunId: '53ff21c8-4872-46c4-83bf-517d54876945',
    accountingDate: '2022-09-30',
    attachmentAssetIds: ['99874519-25ce-46ff-8823-093115aa7222']
  })
};

fetch('https://eu.sequencehq.com/api/invoices', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingScheduleId' => 'fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95',
    'currency' => 'GBP',
    'dueDate' => '2022-09-30',
    'purchaseOrderNumber' => 'PO123',
    'reference' => 'ref',
    'customerEmails' => [
        'customer.user.a@example.com',
        'customer.user.b@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',
        'town' => 'Springfield',
        'state' => 'CA',
        'postcode' => '12345',
        'country' => 'US'
    ],
    'memo' => 'Thanks',
    'paymentOptions' => [
        'BANK_TRANSFER'
    ],
    'billingPeriod' => [
        'start' => '2022-10-01',
        'endInclusive' => '2022-10-30'
    ],
    'customerId' => '61b083e0-1faa-47ca-9aeb-6205da8f6c47',
    'metadata' => [
        [
                'key' => 'example-label',
                'value' => 'label-value'
        ]
    ],
    'creditBalances' => 'Verification 2 credit balance: 7/7 (expiring on 4 May 2023)',
    'billingRunId' => '53ff21c8-4872-46c4-83bf-517d54876945',
    'accountingDate' => '2022-09-30',
    'attachmentAssetIds' => [
        '99874519-25ce-46ff-8823-093115aa7222'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/invoices"

	payload := strings.NewReader("{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	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")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/invoices")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}"

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

{
  "id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "billingRunId": "9c5fdd27-1f7a-41e7-ab67-14f65272a853",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV00001",
  "issueDate": "2022-09-15",
  "dueDate": "2022-09-30",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@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",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "totalTax": "2.50",
  "netTotal": "51.20",
  "grossTotal": "101.23",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "customerTaxId": "TAX123",
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "updatedAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "af60cab3-812d-4250-a051-0fb7133a00c7"
  ],
  "linkedServices": [
    {
      "externalId": "123",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "The White House",
      "line2": "1600 Pennsylvania Avenue",
      "town": "Washington, D.C.",
      "state": "CA",
      "postcode": "20500",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "finance@example.com",
    "taxId": "TAX60",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "000000",
      "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"
      }
    },
    "caBankAccountDetails": {
      "transitNumber": "123",
      "institutionNumber": "12345",
      "accountNumber": "1234567"
    },
    "canadianInternationalDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "transitNumber": "12345",
      "bankName": "Chase",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      },
      "institutionNumber": "123",
      "swiftCode": "CHASUS33",
      "intermediaryBank": {
        "bankName": "Chase",
        "bankAddress": {
          "line1": "JP Morgan Chase",
          "town": "New York City",
          "state": "NY",
          "postcode": "10017",
          "country": "US"
        },
        "swiftCode": "CHASUS33",
        "routingNumber": "123456789"
      }
    },
    "australianDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "swiftCode": "CHASUS33",
      "bsb": "123456"
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "The Merchant"
    },
    "logoUrl": "logo",
    "legalCompanyName": "The Merchant",
    "primaryColour": "#000000",
    "customFields": [
      {
        "key": "example-label",
        "value": "label-value"
      }
    ],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "dunningStatus": "SCHEDULED",
  "accountingDate": "2022-09-30",
  "calculatedAt": "2022-09-30T00:00:00Z",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "attachmentAssets": [
    {
      "id": "4b36a61e-425e-4640-aa26-6224c577b613",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "type": "DOCUMENT",
      "format": "PDF",
      "fileName": "my-document.pdf",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/6cedbb5e-4f77-4217-b8d4-020e7e4d33c9/documents/4B36A61E-425E-4640-AA26-6224C577B613.pdf",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "balance": "1000.00",
  "balanceVersion": 0,
  "integrationPaymentStatuses": {
    "stripe": "PAID",
    "goCardless": "CANCELLED"
  },
  "appliedCreditNotes": [
    {
      "id": "8f3a5b1e-0c2d-4e6f-8a9b-1c2d3e4f5a6b",
      "creditNoteNumber": "CN00001",
      "netTotal": "41.67",
      "totalTax": "8.33",
      "grossTotal": "50.00",
      "lineItems": [
        {
          "name": "Adjustment",
          "netTotal": "41.67",
          "grossTotal": "50.00",
          "invoiceLineItemIds": [
            "2d4f6a8b-1c3e-4f5a-9b7d-8e6f5a4b3c2d"
          ]
        }
      ]
    }
  ],
  "appliedCreditGrants": [
    {
      "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
      "creditGrantName": "Q3 prepaid credit",
      "amount": "820.00",
      "taxAmount": "164.00",
      "status": "APPLIED"
    }
  ],
  "projectedCreditGrants": [
    {
      "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
      "creditGrantName": "Q3 prepaid credit",
      "amount": "30.00"
    }
  ],
  "projectedAmountDue": "71.23",
  "paymentAllocations": [
    {
      "paymentId": "3f9c1a7d-6b2e-4c8a-9d5f-0e1a2b3c4d5e",
      "amount": "50.00",
      "allocatedAt": "2022-10-30T00:00:00Z",
      "paidAt": "2022-10-29T00:00:00Z",
      "origin": "MANUAL"
    }
  ],
  "paymentTermDays": 30,
  "dueDateSource": "CALCULATED",
  "dueDatePolicy": {
    "paymentTermDays": 30,
    "type": "PAYMENT_TERMS"
  },
  "dueDateStatus": "SET"
}

This response has no body data.

This response has no body data.

This response has no body data.

POST

invoices

Create an invoice

curl --request POST \
  --url https://eu.sequencehq.com/api/invoices \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "currency": "GBP",
  "dueDate": "2022-09-30",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@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",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
  "accountingDate": "2022-09-30",
  "attachmentAssetIds": [
    "99874519-25ce-46ff-8823-093115aa7222"
  ]
}
'

import requests

url = "https://eu.sequencehq.com/api/invoices"

payload = {
    "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
    "currency": "GBP",
    "dueDate": "2022-09-30",
    "purchaseOrderNumber": "PO123",
    "reference": "ref",
    "customerEmails": ["customer.user.a@example.com", "customer.user.b@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",
        "town": "Springfield",
        "state": "CA",
        "postcode": "12345",
        "country": "US"
    },
    "memo": "Thanks",
    "paymentOptions": ["BANK_TRANSFER"],
    "billingPeriod": {
        "start": "2022-10-01",
        "endInclusive": "2022-10-30"
    },
    "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
    "metadata": [
        {
            "key": "example-label",
            "value": "label-value"
        }
    ],
    "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
    "billingRunId": "53ff21c8-4872-46c4-83bf-517d54876945",
    "accountingDate": "2022-09-30",
    "attachmentAssetIds": ["99874519-25ce-46ff-8823-093115aa7222"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    billingScheduleId: 'fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95',
    currency: 'GBP',
    dueDate: '2022-09-30',
    purchaseOrderNumber: 'PO123',
    reference: 'ref',
    customerEmails: ['customer.user.a@example.com', 'customer.user.b@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',
      town: 'Springfield',
      state: 'CA',
      postcode: '12345',
      country: 'US'
    },
    memo: 'Thanks',
    paymentOptions: ['BANK_TRANSFER'],
    billingPeriod: {start: '2022-10-01', endInclusive: '2022-10-30'},
    customerId: '61b083e0-1faa-47ca-9aeb-6205da8f6c47',
    metadata: [{key: 'example-label', value: 'label-value'}],
    creditBalances: 'Verification 2 credit balance: 7/7 (expiring on 4 May 2023)',
    billingRunId: '53ff21c8-4872-46c4-83bf-517d54876945',
    accountingDate: '2022-09-30',
    attachmentAssetIds: ['99874519-25ce-46ff-8823-093115aa7222']
  })
};

fetch('https://eu.sequencehq.com/api/invoices', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'billingScheduleId' => 'fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95',
    'currency' => 'GBP',
    'dueDate' => '2022-09-30',
    'purchaseOrderNumber' => 'PO123',
    'reference' => 'ref',
    'customerEmails' => [
        'customer.user.a@example.com',
        'customer.user.b@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',
        'town' => 'Springfield',
        'state' => 'CA',
        'postcode' => '12345',
        'country' => 'US'
    ],
    'memo' => 'Thanks',
    'paymentOptions' => [
        'BANK_TRANSFER'
    ],
    'billingPeriod' => [
        'start' => '2022-10-01',
        'endInclusive' => '2022-10-30'
    ],
    'customerId' => '61b083e0-1faa-47ca-9aeb-6205da8f6c47',
    'metadata' => [
        [
                'key' => 'example-label',
                'value' => 'label-value'
        ]
    ],
    'creditBalances' => 'Verification 2 credit balance: 7/7 (expiring on 4 May 2023)',
    'billingRunId' => '53ff21c8-4872-46c4-83bf-517d54876945',
    'accountingDate' => '2022-09-30',
    'attachmentAssetIds' => [
        '99874519-25ce-46ff-8823-093115aa7222'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.sequencehq.com/api/invoices"

	payload := strings.NewReader("{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	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")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/invoices")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billingScheduleId\": \"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95\",\n  \"currency\": \"GBP\",\n  \"dueDate\": \"2022-09-30\",\n  \"purchaseOrderNumber\": \"PO123\",\n  \"reference\": \"ref\",\n  \"customerEmails\": [\n    \"customer.user.a@example.com\",\n    \"customer.user.b@example.com\"\n  ],\n  \"customerLegalCompanyName\": \"Facebook\",\n  \"customerBillingAddress\": {\n    \"line1\": \"Flat 1\",\n    \"line2\": \"15 Yemen Road\",\n    \"town\": \"Yemen\",\n    \"state\": \"CA\",\n    \"postcode\": \"YE1 2YE\",\n    \"country\": \"YE\"\n  },\n  \"customerShippingAddress\": {\n    \"line1\": \"742 Evergreen Terrace\",\n    \"town\": \"Springfield\",\n    \"state\": \"CA\",\n    \"postcode\": \"12345\",\n    \"country\": \"US\"\n  },\n  \"memo\": \"Thanks\",\n  \"paymentOptions\": [\n    \"BANK_TRANSFER\"\n  ],\n  \"billingPeriod\": {\n    \"start\": \"2022-10-01\",\n    \"endInclusive\": \"2022-10-30\"\n  },\n  \"customerId\": \"61b083e0-1faa-47ca-9aeb-6205da8f6c47\",\n  \"metadata\": [\n    {\n      \"key\": \"example-label\",\n      \"value\": \"label-value\"\n    }\n  ],\n  \"creditBalances\": \"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)\",\n  \"billingRunId\": \"53ff21c8-4872-46c4-83bf-517d54876945\",\n  \"accountingDate\": \"2022-09-30\",\n  \"attachmentAssetIds\": [\n    \"99874519-25ce-46ff-8823-093115aa7222\"\n  ]\n}"

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

{
  "id": "6cedbb5e-4f77-4217-b8d4-020e7e4d33c9",
  "sequenceAccountId": "68233908-402a-43b4-8952-1c2ab0ef0b25",
  "billingScheduleId": "fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95",
  "billingRunId": "9c5fdd27-1f7a-41e7-ab67-14f65272a853",
  "status": "DRAFT",
  "currency": "GBP",
  "invoiceNumber": "INV00001",
  "issueDate": "2022-09-15",
  "dueDate": "2022-09-30",
  "purchaseOrderNumber": "PO123",
  "reference": "ref",
  "customerEmails": [
    "customer.user.a@example.com",
    "customer.user.b@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",
    "town": "Springfield",
    "state": "CA",
    "postcode": "12345",
    "country": "US"
  },
  "memo": "Thanks",
  "paymentOptions": [
    "BANK_TRANSFER"
  ],
  "billingPeriod": {
    "start": "2022-10-01",
    "endInclusive": "2022-10-30"
  },
  "customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
  "totalTax": "2.50",
  "netTotal": "51.20",
  "grossTotal": "101.23",
  "metadata": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "customerTaxId": "TAX123",
  "paymentStatus": "UNPAID",
  "createdAt": "2022-10-30T00:00:00Z",
  "updatedAt": "2022-10-30T00:00:00Z",
  "creditNoteIds": [
    "af60cab3-812d-4250-a051-0fb7133a00c7"
  ],
  "linkedServices": [
    {
      "externalId": "123",
      "externalService": "Xero",
      "syncTime": "2022-06-28T16:47:00Z",
      "externalUrl": "https://invoicing.xero.com/view/85e52542-3e54-4f0d-872b-33bba11a0504"
    }
  ],
  "merchantDetails": {
    "address": {
      "line1": "The White House",
      "line2": "1600 Pennsylvania Avenue",
      "town": "Washington, D.C.",
      "state": "CA",
      "postcode": "20500",
      "country": "US"
    },
    "phoneNumber": "0800001066",
    "email": "finance@example.com",
    "taxId": "TAX60",
    "iban": "GB33BUKB20201555555555",
    "ukAccountDetails": {
      "sortCode": "000000",
      "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"
      }
    },
    "caBankAccountDetails": {
      "transitNumber": "123",
      "institutionNumber": "12345",
      "accountNumber": "1234567"
    },
    "canadianInternationalDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "transitNumber": "12345",
      "bankName": "Chase",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      },
      "institutionNumber": "123",
      "swiftCode": "CHASUS33",
      "intermediaryBank": {
        "bankName": "Chase",
        "bankAddress": {
          "line1": "JP Morgan Chase",
          "town": "New York City",
          "state": "NY",
          "postcode": "10017",
          "country": "US"
        },
        "swiftCode": "CHASUS33",
        "routingNumber": "123456789"
      }
    },
    "australianDestination": {
      "legalName": "John Doe",
      "accountNumber": "12345678",
      "swiftCode": "CHASUS33",
      "bsb": "123456"
    },
    "swedishBankgiroDestination": {
      "bankgiroNumber": "123-4567",
      "accountName": "The Merchant"
    },
    "logoUrl": "logo",
    "legalCompanyName": "The Merchant",
    "primaryColour": "#000000",
    "customFields": [
      {
        "key": "example-label",
        "value": "label-value"
      }
    ],
    "includeBeneficiaryAddressInPaymentDetails": false
  },
  "creditBalances": "Verification 2 credit balance: 7/7 (expiring on 4 May 2023)",
  "dunningStatus": "SCHEDULED",
  "accountingDate": "2022-09-30",
  "calculatedAt": "2022-09-30T00:00:00Z",
  "customerTaxStatus": "TAXED",
  "renderSettings": {
    "paymentLinkDisplay": "HIDE_PAYMENT_LINK"
  },
  "isCustomerArchived": false,
  "attachmentAssets": [
    {
      "id": "4b36a61e-425e-4640-aa26-6224c577b613",
      "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
      "type": "DOCUMENT",
      "format": "PDF",
      "fileName": "my-document.pdf",
      "fileSizeBytes": 12345,
      "url": "https://assets.sequencehq.com/6cedbb5e-4f77-4217-b8d4-020e7e4d33c9/documents/4B36A61E-425E-4640-AA26-6224C577B613.pdf",
      "createdAt": "2022-06-28T16:47:00Z"
    }
  ],
  "balance": "1000.00",
  "balanceVersion": 0,
  "integrationPaymentStatuses": {
    "stripe": "PAID",
    "goCardless": "CANCELLED"
  },
  "appliedCreditNotes": [
    {
      "id": "8f3a5b1e-0c2d-4e6f-8a9b-1c2d3e4f5a6b",
      "creditNoteNumber": "CN00001",
      "netTotal": "41.67",
      "totalTax": "8.33",
      "grossTotal": "50.00",
      "lineItems": [
        {
          "name": "Adjustment",
          "netTotal": "41.67",
          "grossTotal": "50.00",
          "invoiceLineItemIds": [
            "2d4f6a8b-1c3e-4f5a-9b7d-8e6f5a4b3c2d"
          ]
        }
      ]
    }
  ],
  "appliedCreditGrants": [
    {
      "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
      "creditGrantName": "Q3 prepaid credit",
      "amount": "820.00",
      "taxAmount": "164.00",
      "status": "APPLIED"
    }
  ],
  "projectedCreditGrants": [
    {
      "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
      "creditGrantName": "Q3 prepaid credit",
      "amount": "30.00"
    }
  ],
  "projectedAmountDue": "71.23",
  "paymentAllocations": [
    {
      "paymentId": "3f9c1a7d-6b2e-4c8a-9d5f-0e1a2b3c4d5e",
      "amount": "50.00",
      "allocatedAt": "2022-10-30T00:00:00Z",
      "paidAt": "2022-10-29T00:00:00Z",
      "origin": "MANUAL"
    }
  ],
  "paymentTermDays": 30,
  "dueDateSource": "CALCULATED",
  "dueDatePolicy": {
    "paymentTermDays": 30,
    "type": "PAYMENT_TERMS"
  },
  "dueDateStatus": "SET"
}

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

Body

application/json

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"

customerId

string

required

The ID of the Customer this invoice is linked to

Example:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

billingScheduleId

string

Billing Schedule ID

Example:

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

dueDate

string

Due date

Example:

"2022-09-30"

purchaseOrderNumber

string

Purchase order number

Example:

"PO123"

reference

string

Reference

Example:

"ref"

customerEmails

string[]

Customer email addresses, used for sending the Invoice if provided

Example:

[
  "customer.user.a@example.com",
  "customer.user.b@example.com"
]

customerLegalCompanyName

string

Customer's legal company name

Example:

"Facebook"

customerBillingAddress

object

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

Customer's billing address

Show child attributes

Example:

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

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"
}

metadata

object[]

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"
  }
]

creditBalances

string

Credit balances

Example:

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

billingRunId

string

Billing Run ID

Example:

"53ff21c8-4872-46c4-83bf-517d54876945"

accountingDate

string

Accounting date

Example:

"2022-09-30"

attachmentAssetIds

string[]

Attachment asset IDs

Example:

["99874519-25ce-46ff-8823-093115aa7222"]

Response

Created

string

required

Invoice ID

Example:

"6cedbb5e-4f77-4217-b8d4-020e7e4d33c9"

sequenceAccountId

string

required

Sequence Account ID

Example:

"68233908-402a-43b4-8952-1c2ab0ef0b25"

status

enum<string>

required

Invoice status

Available options:

IN_PROGRESS,

DRAFT,

FINAL,

SENT,

VOIDED

Example:

"DRAFT"

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.user.a@example.com",
  "customer.user.b@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:

"61b083e0-1faa-47ca-9aeb-6205da8f6c47"

totalTax

string

required

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

Example:

"2.50"

netTotal

string

required

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

Example:

"51.20"

grossTotal

string

required

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

Example:

"101.23"

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"

updatedAt

string

required

Updated time

Example:

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

creditNoteIds

string[]

required

IDs of linked credit notes (if any)

Example:

["af60cab3-812d-4250-a051-0fb7133a00c7"]

linkedServices

object[]

required

External services which are linked to this invoice

Show child attributes

Example:

[
  {
    "externalId": "123",
    "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-09-30"

renderSettings

object

required

Settings that control how the invoice is rendered.

Show child attributes

Example:

{ "paymentLinkDisplay": "HIDE_PAYMENT_LINK" }

isCustomerArchived

boolean

required

isCustomerArchived

Example:

false

integrationPaymentStatuses

object

required

Payment or sync status per integration service

Show child attributes

Example:

{
  "stripe": "PAID",
  "goCardless": "CANCELLED"
}

appliedCreditNotes

object[]

required

Credit notes applied to this invoice, with per-credit-note totals and line items

Show child attributes

Example:

[
  {
    "id": "8f3a5b1e-0c2d-4e6f-8a9b-1c2d3e4f5a6b",
    "creditNoteNumber": "CN00001",
    "netTotal": "41.67",
    "totalTax": "8.33",
    "grossTotal": "50.00",
    "lineItems": [
      {
        "name": "Adjustment",
        "netTotal": "41.67",
        "grossTotal": "50.00",
        "invoiceLineItemIds": ["2d4f6a8b-1c3e-4f5a-9b7d-8e6f5a4b3c2d"]
      }
    ]
  }
]

appliedCreditGrants

object[]

required

Credit grants applied to this invoice, with the total credit each grant contributed

Show child attributes

Example:

[
  {
    "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
    "creditGrantName": "Q3 prepaid credit",
    "amount": "820.00",
    "taxAmount": "164.00",
    "status": "APPLIED"
  }
]

projectedCreditGrants

object[]

required

Credit grants expected to reduce this invoice when it is finalised, one row per grant. An estimate that is only locked in at finalisation, and empty once the invoice has been finalised.

Show child attributes

Example:

[
  {
    "creditGrantId": "0198b2c9-5f41-7c3d-9a8e-2b4c6d8e0f13",
    "creditGrantName": "Q3 prepaid credit",
    "amount": "30.00"
  }
]

projectedAmountDue

string

required

What this invoice is expected to owe once projectedCreditGrants is applied to it, and grossTotal itself where nothing is projected, rounded to the currency's scale. An estimate that is only locked in at finalisation.

Example:

"71.23"

paymentAllocations

object[]

required

Payments allocated to this invoice, with per-payment amounts and dates

Show child attributes

Example:

[
  {
    "paymentId": "3f9c1a7d-6b2e-4c8a-9d5f-0e1a2b3c4d5e",
    "amount": "50.00",
    "allocatedAt": "2022-10-30T00:00:00Z",
    "paidAt": "2022-10-29T00:00:00Z",
    "origin": "MANUAL"
  }
]

paymentTermDays

integer | null

required

Payment terms in days. The due date is computed from these terms.

Example:

30

dueDateSource

enum<string>

required

How the due date was determined: MANUAL when set to a fixed date, CALCULATED when computed from payment terms.

Available options:

MANUAL,

CALCULATED

Example:

"CALCULATED"

dueDatePolicy

object

required

How the due date is set: MANUAL for a date chosen by hand, PAYMENT_TERMS for a number of days after the due date anchor. Null when the invoice has neither a due date nor payment terms. Send the same value back to keep the policy, a different one to change it.

Option 1
Option 2

Show child attributes

Example:

{
  "date": "2022-10-30",
  "type": "PAYMENT_TERMS"
}

dueDateStatus

enum<string>

required

Whether the invoice has its due date yet. PENDING means it has none: an account that anchors due dates to the issue date fills the due date in when the invoice is issued.

Available options:

SET,

PENDING

Example:

"SET"

billingScheduleId

string

Billing Schedule ID

Example:

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

billingRunId

string

Billing Run ID

Example:

"9c5fdd27-1f7a-41e7-ab67-14f65272a853"

invoiceNumber

string

Invoice number

Example:

"INV00001"

issueDate

string

Issue date

Example:

"2022-09-15"

dueDate

string

Due date

Example:

"2022-09-30"

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"
}

customerTaxId

string

Customer's tax ID

Example:

"TAX123"

merchantDetails

object

Merchant details

Show child attributes

Example:

{
  "address": {
    "line1": "The White House",
    "line2": "1600 Pennsylvania Avenue",
    "town": "Washington, D.C.",
    "state": "CA",
    "postcode": "20500",
    "country": "US"
  },
  "phoneNumber": "0800001066",
  "email": "finance@example.com",
  "taxId": "TAX60",
  "iban": "GB33BUKB20201555555555",
  "ukAccountDetails": {
    "sortCode": "000000",
    "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"
    }
  },
  "caBankAccountDetails": {
    "transitNumber": "123",
    "institutionNumber": "12345",
    "accountNumber": "1234567"
  },
  "canadianInternationalDestination": {
    "legalName": "John Doe",
    "accountNumber": "12345678",
    "transitNumber": "12345",
    "bankName": "Chase",
    "bankAddress": {
      "line1": "JP Morgan Chase",
      "town": "New York City",
      "state": "NY",
      "postcode": "10017",
      "country": "US"
    },
    "institutionNumber": "123",
    "swiftCode": "CHASUS33",
    "intermediaryBank": {
      "bankName": "Chase",
      "bankAddress": {
        "line1": "JP Morgan Chase",
        "town": "New York City",
        "state": "NY",
        "postcode": "10017",
        "country": "US"
      },
      "swiftCode": "CHASUS33",
      "routingNumber": "123456789"
    }
  },
  "australianDestination": {
    "legalName": "John Doe",
    "accountNumber": "12345678",
    "swiftCode": "CHASUS33",
    "bsb": "123456"
  },
  "swedishBankgiroDestination": {
    "bankgiroNumber": "123-4567",
    "accountName": "The Merchant"
  },
  "logoUrl": "logo",
  "legalCompanyName": "The Merchant",
  "primaryColour": "#000000",
  "customFields": [
    {
      "key": "example-label",
      "value": "label-value"
    }
  ],
  "includeBeneficiaryAddressInPaymentDetails": false
}

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"

customerTaxStatus

enum<string>

Customer tax status

Available options:

TAXED,

TAX_EXEMPT,

REVERSE_CHARGED

Example:

"TAXED"

attachmentAssets

object[]

Assets attached to this invoice

Show child attributes

Example:

[
  {
    "id": "4b36a61e-425e-4640-aa26-6224c577b613",
    "createdBy": "94703530-1293-479b-bd37-ccad42fd9c8b",
    "type": "DOCUMENT",
    "format": "PDF",
    "fileName": "my-document.pdf",
    "fileSizeBytes": 12345,
    "url": "https://assets.sequencehq.com/6cedbb5e-4f77-4217-b8d4-020e7e4d33c9/documents/4B36A61E-425E-4640-AA26-6224C577B613.pdf",
    "createdAt": "2022-06-28T16:47:00Z"
  }
]

balance

string

Outstanding amount owed on this invoice

Example:

"1000.00"

balanceVersion

integer<int64>

Ledger version of the balance. Advances each time the balance changes; null when the invoice has no ledger balance.

Example:

0

API Reference

Latest Live API

Version 2024-07-30

Create an invoice

Headers

Body

Response