Read Bukku contacts, accounts, invoices, bills and journals; create contacts and sales invoices.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: create a contact (customer, supplier and/or employee) in Bukku. The contact code must be unique (A-Z, 0-9, _ and -, max 15 characters). POST /contacts.
Contact types; a contact can be several.
Legal name of the contact.
Entity type (used for MyInvois).
Unique code, for example C-A0001.
Registration number. Required for MALAYSIAN_COMPANY (with reg_no_type); individuals need it or tax_id_no.
Malaysian TIN / tax id (11-14 characters). Required for MALAYSIAN_COMPANY; individuals need it or reg_no.
Trading or display name.
Registration number type; send together with reg_no.
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: create a contact (customer, supplier and/or employee) in Bukku. The contact code must be unique (A-Z, 0-9, _ and -, max 15 characters). POST /contacts.
| Argument | Type | Description |
|---|---|---|
| string | ||
| types* | array | Contact types; a contact can be several. |
| reg_no | string | Registration number. Required for MALAYSIAN_COMPANY (with reg_no_type); individuals need it or tax_id_no. |
| remarks | string | |
| phone_no | string | |
| tax_id_no | string | Malaysian TIN / tax id (11-14 characters). Required for MALAYSIAN_COMPANY; individuals need it or reg_no. |
| legal_name* | string | Legal name of the contact. |
| other_name | string | Trading or display name. |
| entity_type* | string | Entity type (used for MyInvois). |
| reg_no_type | string | Registration number type; send together with reg_no. |
| contact_code* | string | Unique code, for example C-A0001. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"legal_name",
"contact_code",
"entity_type",
"types"
],
"properties": {
"email": {
"type": "string",
"maxLength": 200,
"minLength": 3
},
"types": {
"type": "array",
"items": {
"enum": [
"customer",
"supplier",
"employee"
],
"type": "string"
},
"maxItems": 3,
"minItems": 1,
"description": "Contact types; a contact can be several."
},
"reg_no": {
"type": "string",
"maxLength": 30,
"minLength": 1,
"description": "Registration number. Required for MALAYSIAN_COMPANY (with reg_no_type); individuals need it or tax_id_no."
},
"remarks": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"phone_no": {
"type": "string",
"maxLength": 40,
"minLength": 3
},
"tax_id_no": {
"type": "string",
"maxLength": 14,
"minLength": 11,
"description": "Malaysian TIN / tax id (11-14 characters). Required for MALAYSIAN_COMPANY; individuals need it or reg_no."
},
"legal_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Legal name of the contact."
},
"other_name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Trading or display name."
},
"entity_type": {
"enum": [
"MALAYSIAN_COMPANY",
"MALAYSIAN_INDIVIDUAL",
"FOREIGN_COMPANY",
"FOREIGN_INDIVIDUAL",
"EXEMPTED_PERSON"
],
"type": "string",
"description": "Entity type (used for MyInvois)."
},
"reg_no_type": {
"enum": [
"NRIC",
"BRN",
"PASSPORT",
"ARMY"
],
"type": "string",
"description": "Registration number type; send together with reg_no."
},
"contact_code": {
"type": "string",
"pattern": "^[A-Z0-9_-]+$",
"maxLength": 15,
"minLength": 1,
"description": "Unique code, for example C-A0001."
}
}
}WRITE: create a sales invoice for a customer. status defaults to draft (nothing posted to the ledger), status ready finalizes it and affects the books. payment_mode credit needs term_items, cash needs deposit_items. Companies with MyInvois submission switched on must pass myinvois_action when status is ready: NORMAL (not sent), EXTERNAL (already validated elsewhere) or VALIDATE (submits the invoice to LHDN MyInvois, which cannot be taken back). Look up contact, account, term and tax code ids first. POST /sales/invoices.
| Argument | Type | Description |
|---|---|---|
| date* | string | Invoice date, yyyy-mm-dd. |
| items* | array | Invoice lines. |
| title | string | |
| number | string | Invoice number, blank uses the default number format. |
| status | string | draft (default) or ready. |
| number2 | string | Reference number. |
| remarks | string | |
| tax_mode* | string | Whether unit prices include tax. |
| contact_id |
One ledger account by id. GET /accounts/{id}.
| Argument | Type | Description |
|---|---|---|
| account_id* | integer | Bukku account id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"account_id"
],
"properties": {
"account_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku account id.",
"exclusiveMinimum": 0
}
}
}One money in, money out or transfer transaction in full. GET /banking/{incomes|expenses|transfers}/{id}.
| Argument | Type | Description |
|---|---|---|
| type* | string | Transaction type. |
| transaction_id* | integer | Bukku transaction id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"transaction_id"
],
"properties": {
"type": {
"enum": [
"money_in",
"money_out",
"transfer"
],
"type": "string",
"description": "Transaction type."
},
"transaction_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku transaction id.",
"exclusiveMinimum": 0
}
}
}One contact with its persons, addresses, tax and registration numbers, default accounts and credit limit. GET /contacts/{id}.
| Argument | Type | Description |
|---|---|---|
| contact_id* | integer | Bukku contact id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id"
],
"properties": {
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku contact id.",
"exclusiveMinimum": 0
}
}
}One journal entry with its debit and credit lines. GET /journal_entries/{id}.
| Argument | Type | Description |
|---|---|---|
| transaction_id* | integer | Bukku transaction id of the journal entry. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"transaction_id"
],
"properties": {
"transaction_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku transaction id of the journal entry.",
"exclusiveMinimum": 0
}
}
}Reference data needed to fill in documents: tax codes, payment terms, payment methods, currencies, countries, accounts, contact groups, product groups, price levels, tag groups, number formats, custom fields and company settings. Read-only (POST /v2/lists is a read endpoint).
| Argument | Type | Description |
|---|---|---|
| lists* | array | Which lists to return, for example ["tax_codes", "terms"]. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lists"
],
"properties": {
"lists": {
"type": "array",
"items": {
"enum": [
"accounts",
"classification_code_list",
"contact_groups",
"countries",
"currencies",
"fields",
"number_formats",
"payment_methods",
"price_levels",
"product_groups",
"settings",
"tag_groups",
"tax_codes",
"terms"
],
"type": "string"
},
"maxItems": 14,
"minItems": 1,
"description": "Which lists to return, for example [\"tax_codes\", \"terms\"]."
}
}
}One product with its units, prices, accounts and tax settings. GET /products/{id}.
| Argument | Type | Description |
|---|---|---|
| product_id* | integer | Bukku product id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"product_id"
],
"properties": {
"product_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku product id.",
"exclusiveMinimum": 0
}
}
}One purchase document in full (lines, taxes, terms, payments, status): a bill, order, goods received note, credit note, payment or refund. GET /purchases/{type}/{id}.
| Argument | Type | Description |
|---|---|---|
| type* | string | Document type. |
| transaction_id* | integer | Bukku transaction id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"transaction_id"
],
"properties": {
"type": {
"enum": [
"bill",
"order",
"goods_received_note",
"credit_note",
"payment",
"refund"
],
"type": "string",
"description": "Document type."
},
"transaction_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku transaction id.",
"exclusiveMinimum": 0
}
}
}One sales document in full (lines, taxes, terms, payments, status): an invoice, quote, order, delivery order, credit note, payment or refund. GET /sales/{type}/{id}.
| Argument | Type | Description |
|---|---|---|
| type* | string | Document type. |
| transaction_id* | integer | Bukku transaction id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"transaction_id"
],
"properties": {
"type": {
"enum": [
"invoice",
"quote",
"order",
"delivery_order",
"credit_note",
"payment",
"refund"
],
"type": "string",
"description": "Document type."
},
"transaction_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku transaction id.",
"exclusiveMinimum": 0
}
}
}List ledger accounts from the chart of accounts, optionally by category. Account ids are used on invoice lines. GET /accounts.
| Argument | Type | Description |
|---|---|---|
| search | string | Keywords to search for in the accounts (max 100 characters). |
| category | string | |
| sort_dir | string | Sort direction. |
| is_archived | boolean | true to show deactivated accounts instead of active ones (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Keywords to search for in the accounts (max 100 characters)."
},
"category": {
"enum": [
"assets",
"liabilities",
"equity",
"income",
"expenses"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"is_archived": {
"type": "boolean",
"description": "true to show deactivated accounts instead of active ones (default false)."
}
}
}List banking transactions: money in (incomes), money out (expenses) or transfers between accounts. contact_id and sort_by do not apply to transfers. GET /banking/{incomes|expenses|transfers}.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type* | string | Which banking transactions to list. |
| search | string | Keywords in the number, reference, title, remarks, description or contact. |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | A date, yyyy-mm-dd. |
| sort_by | string | Money in / money out only. |
| sort_dir | string | Sort direction. |
| date_from | string | A date, yyyy-mm-dd. |
| page_size | integer |
List the contact groups; use their ids to filter bukku_list_contacts. GET /contacts/groups.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List contacts (customers, suppliers, employees) with name, code, type, receivable and payable balances. Search matches the name, receivable, payable and created date. GET /contacts.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type | string | Only this contact type. |
| search | string | Keywords in the name, receivable, payable or created date (max 100 characters). |
| status | string | ACTIVE (default), INACTIVE (archived) or ALL contacts. |
| sort_by | string | |
| group_id | integer | Only contacts in this contact group (see bukku_list_contact_groups). |
| sort_dir | string | Sort direction. |
| page_size | integer | Results per page, 1-100 (default 30). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"customer",
"supplier",
"employee"
],
"type": "string",
"description": "Only this contact type."
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Keywords in the name, receivable, payable or created date (max 100 characters)."
},
"status": {
"enum": [
"ALL",
"ACTIVE",
"INACTIVE"
],
"type": "string",
"description": "ACTIVE (default), INACTIVE (archived) or ALL contacts."
},
"sort_by": {
"enum": [
"name",
"receivable",
"payable",
"created_at"
],
"type": "string"
},
"group_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only contacts in this contact group (see bukku_list_contact_groups).",
"exclusiveMinimum": 0
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
}
}
}List manual journal entries by date, status or keywords. GET /journal_entries.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| search | string | Keywords in the number, reference, title, remarks or description. |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | A date, yyyy-mm-dd. |
| sort_dir | string | Sort direction. |
| date_from | string | A date, yyyy-mm-dd. |
| page_size | integer | Results per page, 1-100 (default 30). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Keywords in the number, reference, title, remarks or description."
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
}
}
}List the product groups. GET /products/groups.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List products and bundles (sales and purchase details, SKU, stock). GET /products.
| Argument | Type | Description |
|---|---|---|
| mode | string | Only products sold or only products purchased. |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type | string | |
| search | string | Keywords in the name, SKU, sale or purchase description or remarks (max 60 characters). |
| sort_dir | string | Sort direction. |
| page_size | integer | Results per page, 1-100 (default 30). |
| include_archived | boolean | true to include archived products. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"mode": {
"enum": [
"sale",
"purchase"
],
"type": "string",
"description": "Only products sold or only products purchased."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"product",
"bundle"
],
"type": "string"
},
"search": {
"type": "string",
"maxLength": 60,
"minLength": 1,
"description": "Keywords in the name, SKU, sale or purchase description or remarks (max 60 characters)."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"include_archived": {
"type": "boolean",
"description": "true to include archived products."
}
}
}List purchase bills with number, date, supplier, amount, balance and payment status. Filter by date, supplier, payment status (PAID, OUTSTANDING, OVERDUE) or keywords. GET /purchases/bills.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| search | string | |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | Bills dated on or before this day, yyyy-mm-dd. |
| sort_dir | string | Sort direction. |
| date_from | string | Bills dated on or after this day, yyyy-mm-dd. |
| page_size | integer | Results per page, 1-100 (default 30). |
| contact_id | integer | Only bills of this supplier. |
| payment_mode | string |
List purchase orders, goods received notes, supplier credit notes, supplier payments or refunds (bills have their own tool, bukku_list_purchase_bills). payment_status applies to credit notes, payments and refunds only. GET /purchases/{orders|goods_received_notes|credit_notes|payments|refunds}.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type* | string | Which purchase document to list. |
| search | string | |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | A date, yyyy-mm-dd. |
| sort_dir | string | Sort direction. |
| date_from | string | A date, yyyy-mm-dd. |
| page_size | integer | Results per page, 1-100 (default 30). |
| contact_id |
List quotes, sales orders, delivery orders, credit notes, customer payments or refunds (invoices have their own tool, bukku_list_sales_invoices). payment_status applies to credit notes, payments and refunds only. GET /sales/{quotes|orders|delivery_orders|credit_notes|payments|refunds}.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| type* | string | Which sales document to list. |
| search | string | |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | A date, yyyy-mm-dd. |
| sort_dir | string | Sort direction. |
| date_from | string | A date, yyyy-mm-dd. |
| page_size | integer | Results per page, 1-100 (default 30). |
| contact_id | integer |
List sales invoices with number, date, contact, amount, balance and payment status. Filter by date, customer, payment status (PAID, OUTSTANDING, OVERDUE) or keywords. GET /sales/invoices.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| search | string | Keywords in the number, reference, title, remarks, description, contact or billing/shipping party. |
| status | string | Only transactions with this status. Without it every status except void is returned. |
| date_to | string | Invoices dated on or before this day, yyyy-mm-dd. |
| sort_by | string | |
| sort_dir | string | Sort direction. |
| date_from | string | Invoices dated on or after this day, yyyy-mm-dd. |
| page_size | integer | Results per page, 1-100 (default 30). |
| contact_id | integer |
List the tags (labels) that can be put on transactions. GET /tags.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}WRITE: archive (is_archived true) or restore (false) a contact. Archiving hides it from active lists; nothing is deleted. PATCH /contacts/{id}.
| Argument | Type | Description |
|---|---|---|
| contact_id* | integer | Bukku contact id. |
| is_archived* | boolean | true to archive, false to unarchive. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id",
"is_archived"
],
"properties": {
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Bukku contact id.",
"exclusiveMinimum": 0
},
"is_archived": {
"type": "boolean",
"description": "true to archive, false to unarchive."
}
}
}| integer |
| Customer contact id (bukku_list_contacts type customer). |
| term_items | array | Payment terms, for payment_mode credit. |
| description | string |
| payment_mode | string | credit (needs term_items) or cash (needs deposit_items). |
| currency_code* | string | Invoice currency, for example MYR. Use the company's home currency unless invoicing in another one. |
| deposit_items | array | Payment received, for payment_mode cash. |
| exchange_rate* | number | Rate from the home currency to currency_code. Use 1 when currency_code is the home currency. |
| myinvois_action | string | MyInvois handling, only with status ready. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_id",
"date",
"items",
"tax_mode",
"currency_code",
"exchange_rate"
],
"properties": {
"date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoice date, yyyy-mm-dd."
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"account_id",
"description",
"unit_price",
"quantity"
],
"properties": {
"discount": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)?%?$",
"maxLength": 14,
"description": "Discount as a value (25.50) or a percentage (10%)."
},
"quantity": {
"type": "number",
"maximum": 1000000000,
"description": "Quantity (up to 4 decimals).",
"exclusiveMinimum": 0
},
"account_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Income account id (bukku_list_accounts, category income).",
"exclusiveMinimum": 0
},
"product_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"unit_price": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Price per unit (up to 4 decimals)."
},
"description": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"description": "Line description (required by Bukku)."
},
"tax_code_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Tax code id (bukku_get_lookup_lists tax_codes).",
"exclusiveMinimum": 0
},
"service_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"product_unit_id": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"classification_code": {
"type": "string",
"maxLength": 10,
"minLength": 1,
"description": "MyInvois classification code (bukku_get_lookup_lists classification_code_list). Required on every line with myinvois_action VALIDATE."
}
}
},
"maxItems": 100,
"minItems": 1,
"description": "Invoice lines."
},
"title": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"number": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Invoice number, blank uses the default number format."
},
"status": {
"enum": [
"draft",
"ready"
],
"type": "string",
"description": "draft (default) or ready."
},
"number2": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Reference number."
},
"remarks": {
"type": "string",
"maxLength": 2000,
"minLength": 1
},
"tax_mode": {
"enum": [
"inclusive",
"exclusive"
],
"type": "string",
"description": "Whether unit prices include tax."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Customer contact id (bukku_list_contacts type customer).",
"exclusiveMinimum": 0
},
"term_items": {
"type": "array",
"items": {
"type": "object",
"required": [
"payment_due"
],
"properties": {
"date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Custom due date, yyyy-mm-dd. Give term_id or date."
},
"term_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payment term id (bukku_get_lookup_lists terms); the due date is calculated. Give term_id or date.",
"exclusiveMinimum": 0
},
"description": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"payment_due": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)?%?$",
"maxLength": 20,
"description": "Amount due, as a value (100.25) or a percentage (20%)."
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Payment terms, for payment_mode credit."
},
"description": {
"type": "string",
"maxLength": 255,
"minLength": 1
},
"payment_mode": {
"enum": [
"cash",
"credit"
],
"type": "string",
"description": "credit (needs term_items) or cash (needs deposit_items)."
},
"currency_code": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "Invoice currency, for example MYR. Use the company's home currency unless invoicing in another one."
},
"deposit_items": {
"type": "array",
"items": {
"type": "object",
"required": [
"account_id",
"amount"
],
"properties": {
"amount": {
"type": "number",
"maximum": 1000000000000,
"description": "Amount received.",
"exclusiveMinimum": 0
},
"number": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Payment reference."
},
"account_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Account the money was deposited to (bukku_list_accounts).",
"exclusiveMinimum": 0
},
"payment_method_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Payment method id (bukku_get_lookup_lists payment_methods).",
"exclusiveMinimum": 0
}
}
},
"maxItems": 50,
"minItems": 1,
"description": "Payment received, for payment_mode cash."
},
"exchange_rate": {
"type": "number",
"maximum": 1000000000,
"description": "Rate from the home currency to currency_code. Use 1 when currency_code is the home currency.",
"exclusiveMinimum": 0
},
"myinvois_action": {
"enum": [
"NORMAL",
"VALIDATE",
"EXTERNAL"
],
"type": "string",
"description": "MyInvois handling, only with status ready."
}
}
}| Results per page, 1-100 (default 30). |
| account_id | integer | Only transactions on this bank/cash account (see bukku_list_accounts). |
| contact_id | integer | Only this contact (money in / money out). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"money_in",
"money_out",
"transfer"
],
"type": "string",
"description": "Which banking transactions to list."
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Keywords in the number, reference, title, remarks, description or contact."
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"sort_by": {
"enum": [
"number",
"number2",
"date",
"contact_name",
"amount",
"description",
"created_at"
],
"type": "string",
"description": "Money in / money out only."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"account_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only transactions on this bank/cash account (see bukku_list_accounts).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only this contact (money in / money out).",
"exclusiveMinimum": 0
}
}
}| payment_status | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Bills dated on or before this day, yyyy-mm-dd."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Bills dated on or after this day, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only bills of this supplier.",
"exclusiveMinimum": 0
},
"payment_mode": {
"enum": [
"cash",
"credit",
"claim"
],
"type": "string"
},
"payment_status": {
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE"
],
"type": "string"
}
}
}| integer |
| Only documents of this supplier. |
| payment_status | string | Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"order",
"goods_received_note",
"credit_note",
"payment",
"refund"
],
"type": "string",
"description": "Which purchase document to list."
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this supplier.",
"exclusiveMinimum": 0
},
"payment_status": {
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE",
"paid",
"outstanding"
],
"type": "string",
"description": "Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types."
}
}
}| Only documents of this customer. |
| payment_status | string | Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"type": {
"enum": [
"quote",
"order",
"delivery_order",
"credit_note",
"payment",
"refund"
],
"type": "string",
"description": "Which sales document to list."
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only documents of this customer.",
"exclusiveMinimum": 0
},
"payment_status": {
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE",
"paid",
"outstanding"
],
"type": "string",
"description": "Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types."
}
}
}| Only invoices of this customer. |
| payment_mode | string |
| payment_status | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"search": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Keywords in the number, reference, title, remarks, description, contact or billing/shipping party."
},
"status": {
"enum": [
"draft",
"pending_approval",
"ready",
"void"
],
"type": "string",
"description": "Only transactions with this status. Without it every status except void is returned."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoices dated on or before this day, yyyy-mm-dd."
},
"sort_by": {
"enum": [
"number",
"date",
"contact_name",
"number2",
"title",
"description",
"amount",
"balance",
"created_at"
],
"type": "string"
},
"sort_dir": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoices dated on or after this day, yyyy-mm-dd."
},
"page_size": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 30).",
"exclusiveMinimum": 0
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only invoices of this customer.",
"exclusiveMinimum": 0
},
"payment_mode": {
"enum": [
"cash",
"credit"
],
"type": "string"
},
"payment_status": {
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE"
],
"type": "string"
}
}
}