1. Branches
The new eTaxGo
Etaxgo V2 Partner API
  • Default module
  • Etaxgo V2 Partner API
  • Authentication
    • Get access token (OAuth 2.0 Client Credentials)
      POST
  • Documents
    • Create tax document with generation pipeline
      POST
    • Generate PDF preview (no DB write)
      POST
    • Create multiple tax documents in one request
      POST
    • Download Excel import template with company branches
      GET
    • Full document detail + line items + linked docs
      GET
    • Import multiple documents from pre-parsed Excel
      POST
    • Advanced document search with date range
      POST
    • Create Debit Note (80) or Credit Note (81)
      POST
    • Create Cancellation Note (T07)
      POST
    • Create a Replacement Tax Invoice (388)
      POST
    • Create multiple tax documents in one request
      POST
    • Generate PDF preview for existing document
      GET
    • Create tax document with generation pipeline
      POST
    • Stream signed PDF from blob storage
      GET
    • Import multiple documents from pre-parsed Excel
      POST
    • Stream signed XML from blob storage
      GET
    • Create Debit Note (80) or Credit Note (81)
      POST
    • Download PDF as attachment (password-protected if enabled)
      GET
    • Create Cancellation Note (T07)
      POST
    • Create Replacement Tax Invoice (388)
      POST
    • Create a Tax Invoice (388)
      POST
    • Create a Credit Note (81)
      POST
    • Create a Debit Note (80)
      POST
    • Create a Cancellation Note (T07)
      POST
  • Auth
    • Register new company + admin user
    • Exchange credentials for JWT tokens
    • Refresh expired access token
    • Initiate password reset email
    • Set initial password using invite token (pwset:)
    • Reset password using forgot-password token (pwreset:)
    • Get current user context
    • Revoke Keycloak sessions
  • Invite
    • Invite staff user to current company
    • Cancel pending invitation
    • Resend set-password email to pending invite
    • Disable user in auth provider (internal)
  • Users
    • List active users for caller's company
    • Update user name/role/status
    • Soft delete user
    • Get caller's signature info
    • Upload or replace caller's signature image
    • Delete caller's signature image
    • Stream caller's signature image binary
  • Customers
    • List customers (cursor-paginated)
    • Create customer
    • Update customer
    • Soft delete customer
    • Validate import data without writing DB
    • Bulk insert validated customers
    • Download XLSX import template
  • Products
    • List products
    • Create product
    • Update product
    • Soft delete product
    • Download product Excel import template
    • Validate product rows before import
    • Commit validated product rows to database
  • Branches
    • List all branches for company
      GET
    • Create branch
      POST
    • Update branch
      POST
    • Soft delete branch
      POST
    • Get branch settings
      GET
    • Save branch settings
      POST
    • List all branches across the tenant (admin only)
      GET
  • Company
    • Get company details
    • Update company name and PDF password setting
    • Get seller branding for LINE LIFF
    • Create new company + HQ branch under caller's tenant
    • List all active companies in the tenant
    • Stream company logo
    • Upload company logo
    • Delete company logo
    • Resolve branchToken → company context for LINE LIFF
    • Resolve default (HQ) branch token for a company
    • Link existing CPT clientId to a company + optionally subscribe
  • Dashboard
    • Get current company + branch info for header
    • Document counts per tab
    • Current month/year financial summary
    • Current month document counts by type
    • Current month sales totals
    • Current year sales totals
    • List documents (cursor-paginated)
    • Distinct creator emails for branch
    • Daily aggregates for a month
    • All documents for a specific date
    • Export monthly document summary as Excel
  • Deliveries
    • Customer delivery records (cursor-paginated)
    • Customer delivery status counts
    • RD delivery records (cursor-paginated)
    • RD delivery status counts
    • Bulk resend email for documents
  • Locations
    • Resolve Thai address codes (sub-district / district / province + post code)
  • Generator
    • [Internal] Trigger document generation pipeline
  • Settings
    • Get document running number configuration
    • Save document running number configuration
  • DBD
    • Proxy DBD company info lookup by tax ID
    • DBD company search proxy
  • HSM
    • [Internal] Sign XML with XAdES-BES (SHA-512)
    • [Internal] Sign PDF with CAdES (SHA-512)
  • Subscription
    • List CPT plan groups
    • List CPT plans
    • CPT subscription state change webhook
    • Current active plan + items (flattened from CPT items[])
    • Preview pricing before checkout
    • Create invoice + switch plan — returns embedUrl
    • Invoice list (page-based, NOT cursor)
    • Invoice detail by invoiceId (integer)
    • Returns CPT-hosted invoice PDF URL
    • Invoice document download
  • Payments
    • Initiate QR PromptPay payment
    • Submit bank transfer notification
    • Payment result by invoiceId
  • TIV Requests
    • List TIV requests (cursor-paginated)
    • Get TIV request detail by ID
    • Reject a TIV request
    • Issue document from TIV request → enqueues pdf.single pipeline
  • DocOne
    • List years with archived documents
    • List months with data for a given year
    • List days with data for a given year+month
    • List files for a date. Query: year, month, day
    • Download single file (PDF or XML)
    • Download multiple files as ZIP archive
  • Internal
    • Update document RD status (called by notifier service)
    • Get current RD status for a document
    • Trigger CPT client creation for newly registered company
    • Delete user from Keycloak (called by core-api on staff deletion)
  • Health
    • Service health check
  • Schemas
    • UserSignatureResponse
    • SuccessResponse
    • SuccessEnvelope
    • BuyerAddress
    • SuccessNull
    • DocumentLineItem
    • ErrorResponse
    • CreateDocumentRequest
    • ValidationErrorResponse
    • PaginatedResponse
    • DocumentSearchRequest
    • PaginationMeta
    • DocumentSearchResponse
    • RegisterRequest
    • TokenResponse
    • TokenRequest
    • PasswordTokenRequest
    • OAuthTokenResponse
    • EmailResponse
    • MeResponse
    • InviteRequest
    • User
    • CompanyOptionItem
    • UpdateUserRequest
    • CustomerRequest
    • CompanyDetailsResponse
    • UpdateCompanyInfoRequest
    • BrandingResponse
    • CreateCompanyRequest
    • SequencePrefixItem
    • SequenceSettingsResponse
    • SaveSequenceSettingsRequest
    • BranchItem
    • ImportProductRow
    • ImportProductPreviewRequest
    • ImportProductPreviewResult
    • ImportProductConfirmRequest
    • ImportProductConfirmResult
    • ProductRequest
    • BranchRequest
    • BranchSettingsRequest
    • SubmitDocumentRequest
    • CreateDocumentResponse
    • OpenAPITaxInvoiceRequest
    • OpenAPITaxInvoiceHeader
    • OpenAPIDocumentDetails
    • OpenAPISellerRef
    • OpenAPIBuyer
    • LocationSearchResponse
    • LocationResult
    • OpenAPIBuyerDelivery
    • OpenAPIDiscount
    • OpenAPILineItem
    • BillDiscountItem
    • OpenAPICreateResponse
    • OpenAPICreateValidationError
    • AdjustmentDocRequest
    • CancelDocRequest
    • ReplacementDocRequest
    • BatchDocumentRequest
    • ImportExcelResponse
    • GenerateRequest
    • CptAddonDto
    • CptPackageDto
    • SignRequest
    • SignResponse
  1. Branches

Create branch

POST
/api/v1/core/branches
Roles: tenant_admin, super_admin

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢200
Created branch
This response does not have a body.
🟠400ValidationError
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/core/branches' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "branchNo": "00001",
    "branchName": "string",
    "branchNameEn": "string",
    "taxId": "string",
    "buildingNumber": "string",
    "buildingName": "string",
    "street": "string",
    "subDistrictCode": "string",
    "districtCode": "string",
    "provinceCode": "string",
    "postCode": "string"
}'
Response Response Example
{
    "success": false,
    "data": null,
    "error": {
        "code": "VALIDATION_FAILED",
        "message": "string",
        "fields": [
            {
                "field": "string",
                "message": "string"
            }
        ]
    }
}
Modified at 2026-06-18 10:47:09
Previous
List all branches for company
Next
Update branch
Built with