https://api.nook.io
Authorization
purchase_id
1
Authorization
purchase_id
Purchase Data
1
{
"reference": "est sed",
"order_date": "1940-04-22",
"issue_date": "1907-11-03",
"invoice_number": "do cupidatat mollit consectetur adipisicing",
"order_number": "exercitation ipsum cupidatat elit Excepteur",
"credit_note_number": "qui ea laborum anim enim",
"order_id": -85001849,
"type": "Order",
"supplier_trading_entity_id": -89922261,
"line_items": [],
"visible_to_supplier": false
}
Authorization
start
limit
name
q
status[]
is_draft
type[]
payment_status[]
state[]
is_approved
is_overdue
supplier_id
accounting_id
due_date_start
due_date_end
last_updated
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
deleted
query
1
Authorization
Purchase Data
1
{
"reference": "in enim",
"use_defaults": false,
"order_id": 50965801,
"supplier_trading_entity_id": 55201772,
"line_items": [],
"currency_id": "GBR"
}
Authorization
purchase_id
Data
1
{
"action": "close_request"
}
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
purchase_id
1
Authorization
1
Authorization
q
country_id
sub_division_id
1
Authorization
sale_id
1
Authorization
sale_id
Sale Data
1
{
"reference": "consectetur laboris fugiat",
"order_date": "1903-03-20",
"issue_date": "1905-03-16",
"due_date": "1909-10-15",
"invoice_number": "aute",
"order_number": "ea tempor sed exercitation",
"credit_note_number": "adipisicing",
"order_id": 31797572,
"currency_id": "GBR",
"inclusive_tax": true,
"type": "Invoice",
"customer_trading_entity_id": -84971988,
"line_items": [],
"visible_to_customer": false
}
Authorization
name
q
start
limit
status[]
is_draft
type[]
payment_status[]
state[]
is_approved
is_overdue
customer_id
accounting_id
due_date_start
due_date_end
last_updated
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
deleted
query
1
Authorization
Sale Data
1
{
"order_date": "1968-10-10",
"issue_date": "1917-07-18",
"due_date": "1926-12-21",
"order_number": "exercitation proident commodo qui laboris",
"credit_note_number": "c",
"use_defaults": false,
"order_id": -34295965,
"auto_submit": false,
"customer_trading_entity_id": 3636279,
"line_items": [],
"currency_id": "GBR",
"visible_to_customer": false
}
Authorization
sale_id
Data
1
{
"action": "processing_success"
}
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
child_id
1
Authorization
start
limit
q
query
sort
1
Authorization
Connect Company Request
1
{
"supplier_or_customer": "Both",
"use_defaults": false,
"country_id": "US",
"sub_division_id": "BE-VLI",
"registration_number": "id pariatur voluptate cillum tempor"
}
Authorization
New Organisation Request
1
{
"use_defaults": false,
"org_type": "Individual",
"country_id": "US",
"given_name": "John",
"family_name": "Smith",
"document_number": "123456789",
"document_issue_id": "GB"
}
Authorization
accounting_id
1
Authorization
accounting_id
1
Authorization
include_archived
trading_entity_id
1
Authorization
trading_entity_id
Data
1
{
"default_sale_tax_rate_id": "elit Excepte",
"default_purchase_tax_rate_id": "aliqua elit",
"default_purchase_account_id": "esse"
}
Authorization
trading_entity_id
1
Authorization
start
limit
include_archived
query
sort
1
Authorization
Data
1
{
"child_id": -81634227,
"child_bank_account": {
"account_number": "nulla nostrud ut",
"routing_code_type": "bank_code",
"int_bic": "voluptate pariatur exercitation labore aliqua",
"currency_id": "GBR",
"bacs_account_number": "culpa nu",
"bacs_sort_code": "Ut adi",
"holder_name": "ut esse amet anim"
},
"name": "Nook",
"is_default": true,
"default_sale_tax_rate_id": "aliquip",
"default_sale_account_id": "sunt",
"default_purchase_tax_rate_id": "in la",
"use_defaults": false,
"metadata": {}
}
Authorization
tax_rate_id
1
Authorization
1
Authorization
Data
1
{
"trade_ids": [
9850533,
84838799,
-11323975
],
"status": "Rejected"
}
Authorization
Data
1
Get 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
.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
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
.
Search on invoice, order, credit note number, reference, trading entity or supplier name or accounting system ID
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 an invoice from the accounting system and return it to the user.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an invoice from the accounting system and create it in the database if it does not exist or update it if it does.
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 credit note from the accounting system and return it to the user.
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 credit note from the accounting system and create it in the database if it does not exist or update it if it does.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an order from the accounting system and return it to the user.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an order from the accounting system and create it in the database if it does not exist or update it if it does.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get textract from PDF associated with 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
.
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 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
.
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 sales.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Search on invoice, order, credit note number, reference, trading entity or customer name or accounting system ID
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 an invoice from the accounting system and return it to the user.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an invoice from the accounting system and create it in the database if it does not exist or update it if it does.
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 credit note from the accounting system and return it to the user.
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 credit note from the accounting system and create it in the database if it does not exist or update it if it does.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an order from the accounting system and return it to the user.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Get an order from the accounting system and create it in the database if it does not exist or update it if it does.
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 contact from the accounting system and return it to the user.
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 contact from the accounting system and create it in the database if it does not exist or update it if it does.
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
.
Approve or reject an invoice, credit not or order.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Approve or reject a payment run.
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.