Skip to main content

Get invoice by identifier of submitted created request

POST 
/v2/ob/invoices/by-request-id/:id

Get invoice by identifier of submitted created request

Request​

Path Parameters

    id uuidrequired

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    Identifier of submitted created request

Responses​

OK

Schema

    data

    object

    Process result data if submitted request is SUCCESS

    authority_status AuthorityStatus (string)

    Possible values: [NOT_SUBMITTED, SUBMITTED, SUCCESS, ERROR, ACCEPTED, REJECTED, CANCELED]

    Tax authority submission status

    id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    Unique identifier for the invoice

    consumer

    object

    Information about the consumer related to the invoice

    code string

    Possible values: <= 255 characters

    Customer code

    organization_name string

    Possible values: <= 255 characters

    Buyer's Name | Purchasing Unit. Required if it is a warehouse release note

    name string

    Possible values: <= 255 characters

    Customer name

    tax_code string

    Possible values: <= 14 characters

    Customer tax code. Required if it is a warehouse release note

    address string

    Possible values: <= 255 characters

    Customer address. Required if it is a warehouse release note

    citizen_identification string

    Possible values: <= 12 characters

    Customer citizen identification card

    phone string

    Possible values: <= 20 characters

    Customer phone number

    buyer_name string

    Possible values: <= 255 characters

    Buyer's name

    bank_account string

    Possible values: <= 255 characters

    Buyer's bank account information

    email string

    Customer email

    code string

    Unique code for identifying the invoice, used to look up invoices

    created_date date-time

    The date when the invoice was created

    serial_number string

    The serial number of the invoice

    date_of_issue date-time

    The date when the invoice was issued

    invoice_lines

    object[]

    List of individual items or services included in the invoice

  • Array [

    • code string

    Possible values: <= 255 characters

    Product code

    name stringrequired

    Possible values: <= 500 characters

    Product name

    unit stringrequired

    Possible values: <= 255 characters

    Unit of Product

    price numberrequired

    Product price

    quantity numberrequired

    Number of products purchased

    tax_amount number

    Total tax payable

    vat_rate VatRate (string)

    Possible values: [UNDECLARED, NONE, ZERO, FIVE, EIGHT, TEN]

    Tax type: NONE | UNDECLARED | ZERO | FIVE | EIGHT | TEN

    amount number

    Amount = (price * quantity) - discount_amount

    discount_amount number

    Discount money

    promoted boolean

    Is promotional item

  • ]

    • invoice_amount

    object

    The total amount for the invoice

    amount_by_vat

    object

    Total amount grouped by VAT

    property name* number

    tax_amount_by_vat

    object

    Tax amount grouped by VAT

    property name* number
    vat_amount number

    Total tax amount

    subtotal number

    Total amount before tax

    total number

    Total amount

    updated_date date-time

    The last date when the invoice was updated

    has_tax_authorities boolean

    Indicate whether the invoice has a code or not

    tax_code_issued string

    Tax authority code

    full_symbol string

    The full symbol representing the invoice

    payment_method PaymentMethod (string)

    Possible values: [CASH, BANK_TRANSFER, UNKNOWN]

    The method used to pay the invoice: UNKNOWN | BANK_TRANSFER | CASH

    payment_currency PaymentCurrency (string)

    Possible values: [VND, USD]

    Default value: VND

    Payment currency

    exchange_rate number

    Exchange rate

    digital_economic_contract string

    Economic Contract Number: Only applicable for warehouse release note sent to agents and is required

    deliverer string

    Transporter's Full Name:Only applicable for warehouse release note. Required for warehouse release note sent to agents.

    contract_no string

    Contract Number: Only applicable for warehouse release note

    consignee string

    Issuer's Full Name: Only applicable for warehouse release note

    means_of_transportation string

    Transportation Vehicle: Only applicable for warehouse release note. Required for internal warehouse release note

    order string

    Internal Transfer Order: Only applicable for internal warehouse release note

    request_id uuid

    Possible values: Value must match regular expression [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}

    Unique identifier of submitted request, is used for tracking processing status and fetch result of asynchronous processing

    status ProcessStatus (string)

    Possible values: [FAILED, SUCCESS, NEW]

    Submitted request processing status

    error

    object

    Error is present if request is FAILED

    code string
    message string
Loading...