BeaconX e-Invoice API
    BeaconX e-Invoice API
    • BeaconX e-Invoice API Documentation
    • API Endpoints
      • B2B e-Invoicing
        • Create Document(s)
        • Cancel Document
        • Void Document
        • Unvoid Document
        • Create Invoice from Receipt
        • Check Status
        • Embed QR Code
        • Invoice Reversal
        • Update Reference Number
      • B2C Receipt
        • Retrieve Receipt
        • Search Receipts
        • Create a Receipt
        • Update existing Receipt
        • Void a Receipt
        • Void Multiple Receipts
        • UnVoid a Receipt
        • Send a Receipt (Email / WhatsApp)
        • Download Receipts Report
        • Create Multiple Receipts (Bulk)
        • Receipt Reversal
        • Update Reference Number
        • Check Status
      • TaxPayer
        • Validate Tax Payer
        • Sync Tax Payer Master List
        • Identity
        • Validate SSM
        • Search TIN
      • Lists
        • Get list of all Classification Codes

    BeaconX e-Invoice API Documentation

    BeaconX Logo

    📄 Contents#

    What is BeaconX e-Invoicing API ?
    Why BeaconX ?
    Change Log
    Point of Sale (POS) Integration Hooks
    API Usage
    Additional Information

    What is BeaconX e-Invoicing API#

    BeaconX API is a gateway that is designed for both B2B and B2C scenarios to transmit data to IRBM for issuing and validating e-Invoice. The API acts as a middleware between the source system and IRBM. Integration with BeaconX middleware means that all future changes will be catered for by BeaconX and integration with source systems (e.g. ERP) shall have minimal to no impact.

    Change Log#

    2024-02-01 - BeaconX API Sandbox ready
    2024-04-12 - BeaconX integration with IRBM Sandbox
    2024-05-10 - Check Status and Cancel/Reject Documents endpoints are ready
    2024-05-30 - Embed QR Code into PDF is in progress
    2024-06-04 - Addition of new paramteres for invoice payload footer_notes, sales_order_number, delivery_order_number, items.total_sales, items.commission_rate for concession type invoices. These fields are to be used for PDF printout.
    2024-09-20 - Added 2 new endpoints in B2B (Void Document and Unvoid Document)

    ERP Activity Diagram#

    This is a proposed general method of implementation on where the hooks should happen. Depending on the architecture of ERP system, there may be variation in how your plan for integration takes place.

    Point of Sale (POS) Activity Diagram#

    This is a proposed general method of implementation on where the hooks should happen. Depending on the architecture of POS system, there may be variation in how your plan for integration takes place.

    API Usage#

    Describes how the API is used.
    API Endpoints with "Yellow" dot on the right denotes it is currently in development and scheduled for next update.
    API Endpoints with "Blue" dot denotes it is currently pending and will be scheduled for next 2 updates.

    Request#

    All requests must
    include the following headers
    Accept: application/json
Authorization: Bearer <API_KEY>
    use JSON content in body
    {
  "reference_number": "ABC-123456789",
  ...
}

    Response#

    Below are some examples of how the API responses are formatted depending on the scenarios:
    Successful response with 1 record
    {
    "status": "OK",
    "message": "",
    "data": [Object]
}
    Successful response with multiple records
    {
    "status": "OK",
    "message": "",
    "data": Array of [Object]
}
    Failed response (The API will always return Response Code 200)
    {
    "status": "Error",
    "message": "No record found.",
    "data": null
}

    End#

    The API documentation is updated from time to time.
    Modified at 2024-09-20 01:59:30
    Next
    Create Document(s)
    Built with