Bukku MCP by usefulapi
Read Bukku contacts, accounts, invoices, bills and journals; create contacts and sales invoices.
Sollte ich dies verwenden
Qualität und Sicherheit
A
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
~6,847Tokens (Tool-Definitionen)
~2.5 KBTypische Antwortgröße
Erhebliche Auswirkung auf die Aufmerksamkeit (5.35% von 128k Kontext)
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"bukku": {
"url": "https://bukku.usefulapi.io/mcp"
}
}
}Remote-Endpunkte
https://bukku.usefulapi.io/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (23)
🟢 Nur lesen🟡 Schreiben🔴 Löschen⚪ Unbekannt
🟢bukku_list_contacts(search, type, status, group_id, sort_by, ...)
List contacts (customers, suppliers, employees) with name, code, type, receivable and payable balances. Search matches the name, receivable, payable and created date. GET /contacts.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Keywords in the name, receivable, payable or created date (max 100 characters).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"type": {
"description": "Only this contact type.",
"type": "string",
"enum": [
"customer",
"supplier",
"employee"
]
},
"status": {
"description": "ACTIVE (default), INACTIVE (archived) or ALL contacts.",
"type": "string",
"enum": [
"ALL",
"ACTIVE",
"INACTIVE"
]
},
"group_id": {
"description": "Only contacts in this contact group (see bukku_list_contact_groups).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"sort_by": {
"type": "string",
"enum": [
"name",
"receivable",
"payable",
"created_at"
]
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_contact(contact_id)
One contact with its persons, addresses, tax and registration numbers, default accounts and credit limit. GET /contacts/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"contact_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku contact id."
}
},
"required": [
"contact_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_contact_groups
List the contact groups; use their ids to filter bukku_list_contacts. GET /contacts/groups.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_accounts(search, category, is_archived, sort_dir)
List ledger accounts from the chart of accounts, optionally by category. Account ids are used on invoice lines. GET /accounts.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Keywords to search for in the accounts (max 100 characters).",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"category": {
"type": "string",
"enum": [
"assets",
"liabilities",
"equity",
"income",
"expenses"
]
},
"is_archived": {
"description": "true to show deactivated accounts instead of active ones (default false).",
"type": "boolean"
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_account(account_id)
One ledger account by id. GET /accounts/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku account id."
}
},
"required": [
"account_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_products(search, mode, type, include_archived, sort_dir, ...)
List products and bundles (sales and purchase details, SKU, stock). GET /products.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Keywords in the name, SKU, sale or purchase description or remarks (max 60 characters).",
"type": "string",
"minLength": 1,
"maxLength": 60
},
"mode": {
"description": "Only products sold or only products purchased.",
"type": "string",
"enum": [
"sale",
"purchase"
]
},
"type": {
"type": "string",
"enum": [
"product",
"bundle"
]
},
"include_archived": {
"description": "true to include archived products.",
"type": "boolean"
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_product(product_id)
One product with its units, prices, accounts and tax settings. GET /products/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku product id."
}
},
"required": [
"product_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_product_groups
List the product groups. GET /products/groups.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_sales_invoices(date_from, date_to, contact_id, payment_status, payment_mode, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"date_from": {
"description": "Invoices dated on or after this day, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"date_to": {
"description": "Invoices dated on or before this day, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"contact_id": {
"description": "Only invoices of this customer.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"payment_status": {
"type": "string",
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE"
]
},
"payment_mode": {
"type": "string",
"enum": [
"cash",
"credit"
]
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"description": "Keywords in the number, reference, title, remarks, description, contact or billing/shipping party.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_by": {
"type": "string",
"enum": [
"number",
"date",
"contact_name",
"number2",
"title",
"description",
"amount",
"balance",
"created_at"
]
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_sales_documents(type, date_from, date_to, contact_id, payment_status, ...)
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}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"quote",
"order",
"delivery_order",
"credit_note",
"payment",
"refund"
],
"description": "Which sales document to list."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"contact_id": {
"description": "Only documents of this customer.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"payment_status": {
"description": "Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types.",
"type": "string",
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE",
"paid",
"outstanding"
]
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_sales_document(type, transaction_id)
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}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"invoice",
"quote",
"order",
"delivery_order",
"credit_note",
"payment",
"refund"
],
"description": "Document type."
},
"transaction_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku transaction id."
}
},
"required": [
"type",
"transaction_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_purchase_bills(date_from, date_to, contact_id, payment_status, payment_mode, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"date_from": {
"description": "Bills dated on or after this day, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"date_to": {
"description": "Bills dated on or before this day, yyyy-mm-dd.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"contact_id": {
"description": "Only bills of this supplier.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"payment_status": {
"type": "string",
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE"
]
},
"payment_mode": {
"type": "string",
"enum": [
"cash",
"credit",
"claim"
]
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_purchase_documents(type, date_from, date_to, contact_id, payment_status, ...)
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}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"order",
"goods_received_note",
"credit_note",
"payment",
"refund"
],
"description": "Which purchase document to list."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"contact_id": {
"description": "Only documents of this supplier.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"payment_status": {
"description": "Credit notes (PAID, OUTSTANDING, OVERDUE), payments and refunds (PAID, OUTSTANDING). Not for the other types.",
"type": "string",
"enum": [
"PAID",
"OUTSTANDING",
"OVERDUE",
"paid",
"outstanding"
]
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_purchase_document(type, transaction_id)
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}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bill",
"order",
"goods_received_note",
"credit_note",
"payment",
"refund"
],
"description": "Document type."
},
"transaction_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku transaction id."
}
},
"required": [
"type",
"transaction_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_journal_entries(date_from, date_to, status, search, sort_dir, ...)
List manual journal entries by date, status or keywords. GET /journal_entries.
Eingabe-Schema
{
"type": "object",
"properties": {
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"description": "Keywords in the number, reference, title, remarks or description.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_journal_entry(transaction_id)
One journal entry with its debit and credit lines. GET /journal_entries/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"transaction_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku transaction id of the journal entry."
}
},
"required": [
"transaction_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_bank_transactions(type, date_from, date_to, account_id, contact_id, ...)
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}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"money_in",
"money_out",
"transfer"
],
"description": "Which banking transactions to list."
},
"date_from": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"date_to": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"account_id": {
"description": "Only transactions on this bank/cash account (see bukku_list_accounts).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"contact_id": {
"description": "Only this contact (money in / money out).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"description": "Only transactions with this status. Without it every status except void is returned.",
"type": "string",
"enum": [
"draft",
"pending_approval",
"ready",
"void"
]
},
"search": {
"description": "Keywords in the number, reference, title, remarks, description or contact.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_by": {
"description": "Money in / money out only.",
"type": "string",
"enum": [
"number",
"number2",
"date",
"contact_name",
"amount",
"description",
"created_at"
]
},
"sort_dir": {
"description": "Sort direction.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"page": {
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100000
},
"page_size": {
"description": "Results per page, 1-100 (default 30).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
}
},
"required": [
"type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_bank_transaction(type, transaction_id)
One money in, money out or transfer transaction in full. GET /banking/{incomes|expenses|transfers}/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"money_in",
"money_out",
"transfer"
],
"description": "Transaction type."
},
"transaction_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku transaction id."
}
},
"required": [
"type",
"transaction_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_list_tags
List the tags (labels) that can be put on transactions. GET /tags.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢bukku_get_lookup_lists(lists)
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).
Eingabe-Schema
{
"type": "object",
"properties": {
"lists": {
"minItems": 1,
"maxItems": 14,
"type": "array",
"items": {
"type": "string",
"enum": [
"accounts",
"classification_code_list",
"contact_groups",
"countries",
"currencies",
"fields",
"number_formats",
"payment_methods",
"price_levels",
"product_groups",
"settings",
"tag_groups",
"tax_codes",
"terms"
]
},
"description": "Which lists to return, for example [\"tax_codes\", \"terms\"]."
}
},
"required": [
"lists"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡bukku_create_contact(legal_name, contact_code, entity_type, types, other_name, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Legal name of the contact."
},
"contact_code": {
"type": "string",
"minLength": 1,
"maxLength": 15,
"pattern": "^[A-Z0-9_-]+$",
"description": "Unique code, for example C-A0001."
},
"entity_type": {
"type": "string",
"enum": [
"MALAYSIAN_COMPANY",
"MALAYSIAN_INDIVIDUAL",
"FOREIGN_COMPANY",
"FOREIGN_INDIVIDUAL",
"EXEMPTED_PERSON"
],
"description": "Entity type (used for MyInvois)."
},
"types": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"customer",
"supplier",
"employee"
]
},
"description": "Contact types; a contact can be several."
},
"other_name": {
"description": "Trading or display name.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"reg_no_type": {
"description": "Registration number type; send together with reg_no.",
"type": "string",
"enum": [
"NRIC",
"BRN",
"PASSPORT",
"ARMY"
]
},
"reg_no": {
"description": "Registration number. Required for MALAYSIAN_COMPANY (with reg_no_type); individuals need it or tax_id_no.",
"type": "string",
"minLength": 1,
"maxLength": 30
},
"tax_id_no": {
"description": "Malaysian TIN / tax id (11-14 characters). Required for MALAYSIAN_COMPANY; individuals need it or reg_no.",
"type": "string",
"minLength": 11,
"maxLength": 14
},
"email": {
"type": "string",
"minLength": 3,
"maxLength": 200
},
"phone_no": {
"type": "string",
"minLength": 3,
"maxLength": 40
},
"remarks": {
"type": "string",
"minLength": 1,
"maxLength": 2000
}
},
"required": [
"legal_name",
"contact_code",
"entity_type",
"types"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡bukku_set_contact_archived(contact_id, is_archived)
WRITE: archive (is_archived true) or restore (false) a contact. Archiving hides it from active lists; nothing is deleted. PATCH /contacts/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"contact_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Bukku contact id."
},
"is_archived": {
"type": "boolean",
"description": "true to archive, false to unarchive."
}
},
"required": [
"contact_id",
"is_archived"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡bukku_create_sales_invoice(contact_id, date, items, tax_mode, currency_code, ...)
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.
Eingabe-Schema
{
"type": "object",
"properties": {
"contact_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Customer contact id (bukku_list_contacts type customer)."
},
"date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Invoice date, yyyy-mm-dd."
},
"items": {
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Income account id (bukku_list_accounts, category income)."
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 500,
"description": "Line description (required by Bukku)."
},
"unit_price": {
"type": "number",
"minimum": 0,
"maximum": 1000000000000,
"description": "Price per unit (up to 4 decimals)."
},
"quantity": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000,
"description": "Quantity (up to 4 decimals)."
},
"product_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"product_unit_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"tax_code_id": {
"description": "Tax code id (bukku_get_lookup_lists tax_codes).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"discount": {
"description": "Discount as a value (25.50) or a percentage (10%).",
"type": "string",
"maxLength": 14,
"pattern": "^\\d+(\\.\\d+)?%?$"
},
"service_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "A date, yyyy-mm-dd."
},
"classification_code": {
"description": "MyInvois classification code (bukku_get_lookup_lists classification_code_list). Required on every line with myinvois_action VALIDATE.",
"type": "string",
"minLength": 1,
"maxLength": 10
}
},
"required": [
"account_id",
"description",
"unit_price",
"quantity"
]
},
"description": "Invoice lines."
},
"tax_mode": {
"type": "string",
"enum": [
"inclusive",
"exclusive"
],
"description": "Whether unit prices include tax."
},
"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."
},
"exchange_rate": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000,
"description": "Rate from the home currency to currency_code. Use 1 when currency_code is the home currency."
},
"payment_mode": {
"description": "credit (needs term_items) or cash (needs deposit_items).",
"type": "string",
"enum": [
"cash",
"credit"
]
},
"term_items": {
"description": "Payment terms, for payment_mode credit.",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"term_id": {
"description": "Payment term id (bukku_get_lookup_lists terms); the due date is calculated. Give term_id or date.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"date": {
"description": "Custom due date, yyyy-mm-dd. Give term_id or date.",
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"payment_due": {
"type": "string",
"maxLength": 20,
"pattern": "^\\d+(\\.\\d+)?%?$",
"description": "Amount due, as a value (100.25) or a percentage (20%)."
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"payment_due"
]
}
},
"deposit_items": {
"description": "Payment received, for payment_mode cash.",
"minItems": 1,
"maxItems": 50,
"type": "array",
"items": {
"type": "object",
"properties": {
"account_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "Account the money was deposited to (bukku_list_accounts)."
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"maximum": 1000000000000,
"description": "Amount received."
},
"payment_method_id": {
"description": "Payment method id (bukku_get_lookup_lists payment_methods).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"number": {
"description": "Payment reference.",
"type": "string",
"minLength": 1,
"maxLength": 50
}
},
"required": [
"account_id",
"amount"
]
}
},
"number": {
"description": "Invoice number, blank uses the default number format.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"number2": {
"description": "Reference number.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"description": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"remarks": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"status": {
"description": "draft (default) or ready.",
"type": "string",
"enum": [
"draft",
"ready"
]
},
"myinvois_action": {
"description": "MyInvois handling, only with status ready.",
"type": "string",
"enum": [
"NORMAL",
"VALIDATE",
"EXTERNAL"
]
}
},
"required": [
"contact_id",
"date",
"items",
"tax_mode",
"currency_code",
"exchange_rate"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Nachweis
Aktuelle Beobachtungen
verifiziertVersion nicht aufgezeichnet23 Tools