Patch an invoice
curl --request PATCH \
--url https://eu.sequencehq.com/api/invoices/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
},
"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/{id}"
payload = {
"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"
},
"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.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'},
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/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'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/{id}"
payload := strings.NewReader("{\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 \"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("PATCH", 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.patch("https://eu.sequencehq.com/api/invoices/{id}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\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 \"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/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\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 \"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": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
"status": "SENT",
"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.Invoices
Patch an invoice
Patch an invoice
PATCH
/
invoices
/
{id}
Patch an invoice
curl --request PATCH \
--url https://eu.sequencehq.com/api/invoices/{id} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"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"
},
"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/{id}"
payload = {
"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"
},
"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.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'},
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/{id}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'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/{id}"
payload := strings.NewReader("{\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 \"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("PATCH", 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.patch("https://eu.sequencehq.com/api/invoices/{id}")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\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 \"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/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\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 \"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": "ba37a392-7054-4dae-ab37-6fee9e23fe06",
"sequenceAccountId": "af9b5988-1d7b-45f6-a188-326df5e59b24",
"status": "SENT",
"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
Your API credentials. Eg. Basic {credentials}.
Use this header to select an API version
Available options:
2024-07-30 Path Parameters
Invoice ID
Body
application/json
Due date
Example:
"2022-09-30"
Purchase order number
Example:
"PO123"
Reference
Example:
"ref"
Customer email addresses, used for sending the Invoice if provided
Example:
[ "customer.user.a@example.com", "customer.user.b@example.com" ]
Customer's legal company name
Example:
"Facebook"
Customer's billing address
Show child attributes
Show child attributes
Example:
{ "line1": "Flat 1", "line2": "15 Yemen Road", "town": "Yemen", "state": "CA", "postcode": "YE1 2YE", "country": "YE" }
Customer's billing address
Show child attributes
Show child attributes
Example:
{ "line1": "Flat 1", "line2": "15 Yemen Road", "town": "Yemen", "state": "CA", "postcode": "YE1 2YE", "country": "YE" }
Invoice memo
Example:
"Thanks"
Invoice payment options
Available options:
BANK_TRANSFER, LINK Example:
["BANK_TRANSFER"]
Billing period
Show child attributes
Show child attributes
Example:
{ "start": "2022-10-01", "endInclusive": "2022-10-30" }
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
Show child attributes
Example:
[ { "key": "example-label", "value": "label-value" } ]
Credit balances
Example:
"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)"
Billing Run ID
Example:
"53ff21c8-4872-46c4-83bf-517d54876945"
Accounting date
Example:
"2022-09-30"
Attachment asset IDs
Example:
["99874519-25ce-46ff-8823-093115aa7222"]
Response
OK
Invoice ID
Example:
"ba37a392-7054-4dae-ab37-6fee9e23fe06"
Sequence Account ID
Example:
"af9b5988-1d7b-45f6-a188-326df5e59b24"
Invoice status
Available options:
IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED Example:
"DRAFT"
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"
Customer email addresses, used for sending the Invoice if provided
Example:
["customer@example.com"]
Customer's legal company name
Example:
"Facebook"
Customer's billing address
Show child attributes
Show child attributes
Example:
{ "line1": "Flat 1", "line2": "15 Yemen Road", "town": "Yemen", "state": "CA", "postcode": "YE1 2YE", "country": "YE" }
Customer's billing address
Show child attributes
Show child attributes
Example:
{ "line1": "Flat 1", "line2": "15 Yemen Road", "town": "Yemen", "state": "CA", "postcode": "YE1 2YE", "country": "YE" }
The ID of the Customer this invoice is linked to
Example:
"b3c0cf23-6717-4cdc-b190-acf8aa6ccd8a"
Total tax, in decimal format of the Invoice's currency
Example:
"2"
Net total, in decimal format of the Invoice's currency
Example:
"12"
Gross total, in decimal format of the Invoice's currency
Example:
"10"
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
Show child attributes
Example:
[ { "key": "example-label", "value": "label-value" } ]
Invoice payment status
Available options:
UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE Example:
"UNPAID"
Creation time
Example:
"2022-10-30T00:00:00Z"
IDs of linked credit notes (if any)
Example:
["941272d1-f840-4e16-b698-0cd455c81e0e"]
External services which are linked to this invoice
Show child attributes
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" } ]
Accounting date
Example:
"2022-10-05"
Settings that control how the invoice is rendered.
Show child attributes
Show child attributes
Example:
{ "paymentLinkDisplay": "HIDE_PAYMENT_LINK" }
Example:
false
Last updated time
Example:
"2022-10-30T00:00:00Z"
Invoice number
Example:
"INV2"
Due date
Example:
"2022-11-05"
Purchase order number
Example:
"PO123"
Reference
Example:
"ref"
Invoice memo
Example:
"Thanks"
Invoice payment options
Available options:
BANK_TRANSFER, LINK Example:
["BANK_TRANSFER"]
Billing period
Show child attributes
Show child attributes
Example:
{ "start": "2022-10-01", "endInclusive": "2022-10-30" }
Merchant details
Show child attributes
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": "donald@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": "12345678" }, "logoUrl": "logo", "legalCompanyName": "The Merchant", "primaryColour": "#000000", "customFields": [ { "key": "example-label", "value": "label-value" } ], "includeBeneficiaryAddressInPaymentDetails": true }
Customer tax status
Available options:
TAXED, TAX_EXEMPT, REVERSE_CHARGED Example:
"TAXED"
Billing Schedule ID
Example:
"fe2fcd0b-4c53-45c7-b2ae-b6c1a7d21e95"
Issue date
Example:
"2022-09-15"
Customer's tax ID
Example:
"TAX123"
Credit balances
Example:
"Verification 2 credit balance: 7/7 (expiring on 4 May 2023)"
Dunning status
Available options:
SCHEDULED, OVERDUE_CHECK_SCHEDULED, COMPLETED, FAILED, NOT_REQUIRED Example:
"SCHEDULED"
Time this invoice was last calculated (applicable for invoices generated by billing engine only)
Example:
"2022-09-30T00:00:00Z"