https://api.nook.ioAuthorization
deleted
purchase_id
1
{}Authorization
start
limit
name
status[]
is_draft
type[]
payment_status[]
state[]
is_approved
is_overdue
supplier_id
due_date_start
due_date_end
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
query
1
{}Authorization
Purchase Data
1
{
"reference": "anim Ut ut",
"order_date": "1936-09-02",
"issue_date": "1911-02-27",
"due_date": "1896-07-19",
"invoice_number": "dolor ut labore cillum anim",
"order_number": "irure qui labore Lorem pariatur",
"credit_note_number": "quis nostrud commodo cillum est",
"use_defaults": false,
"auto_submit": false,
"supplier_trading_entity_id": -43158154,
"type": "Invoice",
"line_items": [],
"currency_id": "GBR",
"inclusive_tax": false,
"visible_to_supplier": false
}{}Authorization
purchase_id
Data
1
{
"action": "delete"
}{}Authorization
1
{}Authorization
q
country_id
sub_division_id
1
{}Authorization
deleted
sale_id
1
{}Authorization
name
start
limit
status[]
is_draft
type[]
payment_status[]
state[]
is_approved
is_overdue
customer_id
due_date_start
due_date_end
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
query
1
{}Authorization
Sale Data
1
{
"order_date": "1926-07-30",
"due_date": "1926-11-25",
"invoice_number": "Excepteur minim",
"customer_trading_entity_id": -30618463,
"currency_id": "GBR"
}{}Authorization
sale_id
Data
1
{
"action": "accept_cancel_request"
}{}Authorization
child_id
1
{}Authorization
start
limit
q
query
sort
1
{}Authorization
Connect Company Request1
{
"company_id": 16347207
}{}Authorization
New Organisation Request1
{
"org_type": "Company",
"name": "Payaable Ltd.",
"country_id": "GB",
"tax_number": "123456789"
}{}Authorization
include_archived
trading_entity_id
1
{}Authorization
trading_entity_id
Data
1
{
"is_default": true
}{}Authorization
trading_entity_id
1
{}Authorization
start
limit
include_archived
query
sort
1
{}Authorization
Data
1
{
"child_id": -10622411,
"child_bank_account": {
"account_number": "ipsum reprehenderit",
"routing_code": "elit ut deserunt",
"routing_code_type": "routing_code",
"int_bic": "laboris fugiat ut eu aliquip",
"int_iban": "Ut ea consectetur",
"currency_id": "GBR",
"bacs_account_number": "irure ex",
"bacs_sort_code": "dolore",
"holder_name": "velit anim sint"
},
"name": "Nook",
"is_default": true,
"default_email": "afjpZriJmrn9Ncd@yxA.luh",
"default_sale_tax_rate_id": "irure",
"default_sale_account_id": "quis in mollit nisi",
"default_purchase_tax_rate_id": "Ut fugiat",
"default_purchase_account_id": "pariatur",
"use_defaults": false,
"metadata": "non proident veniam Duis sint"
}{}Authorization
tax_rate_id
1
{}Authorization
1
{}Get the latest version of a purchase by ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Whether deleted invoices should be retrievable
List purchases.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Deprecated, use type, payment and trade status
Deprecated, use type, payment and trade status
Create a purchase.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get information about the company for whom you're calling the API.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Discover for companies to connect to. Companies are retrieved from either Nook or a company register, such as Companies' House.
To search through companies you've connected to, use the /network
list endpoint.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
A search query, matching either in the company name or registration number
The country the resulting companies should be registered in as an ISO 3166 alpha-2 country code
The country subdivision the resulting companies should be registered in as an ISO 3166-1 country subdivision code
Get the latest version of a sale by ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Whether deleted sales should be retrievable
List all sales.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Deprecated, use type, payment and trade status
Deprecated, use type, payment and trade status
Create a sale.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get the network edge for a connected company by its company ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List all companies in your network.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
A search query, matching either in the company name or registration number
Connect to a company by either their company ID or registration
number. /network/connect is the preferred way to connect to companies, as
it allows the automatic set-up of company detail, which makes
payments to these organisations more likely to succeed. The
/network/discover endpoint can help you find the correct company.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Create a new company in the network. /network/connect is the
preferred way to connect to companies. /network/new should only be
used if the company cannot be found through /companies/discover or
when the entity added to the network is an individual. Adding a new
company that has not been identified in a registry may cause delays
or other issues when paying the added company.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get a trading entity its ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Update the trading entity with the given ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Archive the trading entity.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List all trading entities in your network.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
create a trading entity.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get a tax rate by ID.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List all tax rates.
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.