https://api.nook.io
Get a purchase by ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
deleted
Whether deleted invoices should be retrievable
purchase_id
1
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
purchase_id
Purchase Data
1
{
"reference": "laboris mollit reprehenderit incididunt",
"order_date": "1913-03-07",
"issue_date": "1938-03-22",
"due_date": "1953-01-07",
"invoice_number": "eiusmod ut elit",
"order_number": "dolor labore in do amet",
"credit_note_number": "pariat",
"order_id": -16816205,
"currency_id": "GBR",
"type": "CreditNote",
"supplier_trading_entity_id": 23383724,
"line_items": [],
"visible_to_supplier": true
}
List purchases.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
start
limit
name
q
Search on invoice, order, credit note number, reference, trading entity or supplier name or accounting system ID
status[]
Deprecated, use type, payment and trade status
is_draft
Deprecated, use type, payment and trade status
type[]
payment_status[]
state[]
is_approved
is_overdue
supplier_id
due_date_start
due_date_end
last_updated
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
query
1
Create a purchase.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Purchase Data
1
{
"due_date": "1938-11-29",
"use_defaults": false,
"order_id": -8845601,
"supplier_trading_entity_id": -1259981,
"type": "Invoice",
"currency_id": "GBR"
}
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
purchase_id
Data
1
{
"action": "accept_close_request"
}
Get an invoice from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an invoice from the accounting system and create it in the database if it does not exist or update it if it does.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get a credit note from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
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.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an order from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an order from the accounting system and create it in the database if it does not exist or update it if it does.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get information about the company for whom you're calling the API.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1
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.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
q
A search query, matching either in the company name or registration number
country_id
The country the resulting companies should be registered in as an ISO 3166 alpha-2 country code
sub_division_id
The country subdivision the resulting companies should be registered in as an ISO 3166-1 country subdivision code
1
Get a sale by ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
deleted
Whether deleted sales should be retrievable
sale_id
1
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
sale_id
Sale Data
1
{
"reference": "adipisicing laborum elit Lorem labore",
"order_date": "1942-05-09",
"issue_date": "1920-11-18",
"due_date": "1934-05-07",
"invoice_number": "nulla enim exercitation Ut",
"order_number": "in",
"credit_note_number": "deserunt qui minim",
"order_id": -14641628,
"currency_id": "GBR",
"inclusive_tax": false,
"type": "PrePayment",
"customer_trading_entity_id": 71597221,
"line_items": []
}
List all sales.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
name
q
Search on invoice, order, credit note number, reference, trading entity or customer name or accounting system ID
start
limit
status[]
Deprecated, use type, payment and trade status
is_draft
Deprecated, use type, payment and trade status
type[]
payment_status[]
state[]
is_approved
is_overdue
customer_id
due_date_start
due_date_end
last_updated
sort
TotalDesc
DueDateDesc
IssueDateDesc
PaymentDateDesc
OrderDateDesc
CreditDateDesc
TotalAsc
query
1
Create a sale.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Sale Data
1
{
"order_number": "et exercitation quis elit",
"order_id": -70354264,
"auto_submit": false,
"customer_trading_entity_id": -12929236,
"currency_id": "GBR"
}
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
sale_id
Data
1
{
"action": "edit"
}
Get an invoice from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an invoice from the accounting system and create it in the database if it does not exist or update it if it does.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get a credit note from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
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.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an order from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get an order from the accounting system and create it in the database if it does not exist or update it if it does.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get the network edge for a connected company by its company ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
child_id
1
List all companies in your network.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
start
limit
q
A search query, matching either in the company name or registration number
query
sort
1
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.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Connect Company Request
1
{
"company_id": 45195836
}
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.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
New Organisation Request
1
{
"use_defaults": false,
"org_type": "Company",
"name": "Payaable Ltd.",
"country_id": "GB"
}
Get a contact from the accounting system and return it to the user.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get a contact from the accounting system and create it in the database if it does not exist or update it if it does.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
accounting_id
1
Get a trading entity its ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
include_archived
trading_entity_id
1
Update the trading entity with the given ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
trading_entity_id
Data
1
{
"child_bank_account": {
"account_number": "sit Lorem culpa",
"routing_code": "sint ut laboris sed reprehenderit",
"routing_code_type": "ifsc",
"int_bic": "velit",
"int_iban": "amet veniam magna",
"currency_id": "GBR",
"bacs_account_number": "do sunta",
"bacs_sort_code": "adipis",
"override_cop_check": true,
"holder_name": "John Doe"
},
"name": "Nook",
"is_default": true,
"default_sale_tax_rate_id": "cupi",
"default_sale_account_id": "consequat dolor dolore",
"default_purchase_tax_rate_id": "Duis veniam ut",
"default_purchase_account_id": "aute dolore u",
"metadata": [
{
"nullable": true
},
{
"nullable": true
},
{
"nullable": true
},
{
"nullable": true
}
]
}
Archive the trading entity.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
trading_entity_id
1
List all trading entities in your network.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
start
limit
include_archived
query
sort
1
create a trading entity.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Data
1
{
"child_id": 79448942,
"name": "Nook",
"default_email": "Q4WCgD@bQbOZWieIYkXDuOmAZsuhg.zmlp",
"default_purchase_tax_rate_id": "fugiat elit aliqua "
}
Get a tax rate by ID.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
tax_rate_id
1
List all tax rates.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
1
Approve or reject an invoice, credit not or order.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Data
1
{
"trade_ids": [
91120502
],
"status": "Approved"
}
Approve or reject a payment run.
Authorization
The Authorization
header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE
.
Data
1