[GET] Query Invoice Detail

Changelogs

Version	Date	Changes by	Description of change
V1.0	Mar 29, 2024	Que Nguyen	Add Table of Contents. Add Changelogs.

API Definition

Get invoice item by invoice number

Resource information
Response format(s)	JSON
Requires authentication?	Yes using token
Request Header
Name	Value
`Content-Type`	`application/json`
`Authorization`	`{{token}}`
Returns
Returns invoice item detail

Response Header
`Content-Type`	`application/json`
Response Body
Field	Type	Description
`InvoiceNumber`	`string`	Invoice Number
`Quantity`	`decimal(18,6)`
`Total`	`decimal(18,6)`	Total amount payable
`IssuedDate`	`DateTime`	Date time utc format
`DueDate`	`DateTime`	Date time utc format
`PaidDate`	`DateTime`	Date time utc format
`Type`	`string`	Type Of Invoice
`TypeDescription`	`string`
`SubTotal`	`decimal(18,6)`	Sub Total
`TotalFee`	`decimal(18,6)`	Total Fee
`TotalReceivable`	`decimal(18,6)`	Total Receivable
`CurrenyCode`	`string`	Currency code of Sell Order
`CurrencySymbolic`	`string`
`TaxPercent`	`decimal(18,6)`	Tax Percentage
`TaxAmount`	`decimal(18,6)`	Tax Amount
`Status`	`string`
`StatusDescription`	`string`
`CreatedTime`	`DateTime`	Date time UTC format
`UpdatedTime`	`DateTime`	Date time UTC format

Response Body Invoice Items
Field	Type	Description
`DeviceName`	`string`	Name of Device
`Vintage`	`int`
`CountryCode`	`string`
`Quantity`	`decimal(18,6)`
`UnitPrice`	`decimal(18,6)`
`TotalPrice`	`decimal(18,6)`
`Description`	`string`

Request

GET /public/v2/invoices/INV-REAP-2023-07-12-00028

Response

200 Success

{
  "Data": {
    "Fees": 0,
    "Tax": 8,
    "TaxPercentage": 0.08,
    "Receiver": {
      "CompanyName": "REDEX Pte. Ltd.",
      "RegistrationNumber": "201834016K",
      "Address": "Blk 71 Ayer Rajah Crescent",
      "BankName": "Oversea-Chinese Banking Corporation Limited",
      "PaymentType": "SwiftCode",
      "PaymentTypeDescription": "Outside US",
      "Currency": "USD",
      "BankAccountNumber": "601278732201",
      "ACHRoutingNumber": null,
      "BankAccountName": "Oversea-Chinese Banking Corporation Limited",
      "BankAccountType": "Checking",
      "BankAccountTypeDescription": "Checking",
      "SwiftCode": "OCBCSGSGXXX"
    },
    "Items": [
      {
        "DeviceName": "T-RECSolar VNTSTK3R2",
        "Vintage": 2023,
        "CountryCode": "VN",
        "Quantity": 10,
        "UnitPrice": 10,
        "TotalPrice": 100,
        "Description": null
      }
    ],
    "InvoiceNumber": "INV-REAP-2023-07-12-00028",
    "Quantity": 10,
    "Total": 108,
    "IssuedDate": "2023-07-12T07:34:49.3535469",
    "DueDate": "2023-07-21T23:59:59.9999999",
    "PaidDate": "2023-07-12T07:43:25",
    "Type": "Trading",
    "TypeDescription": null,
    "SubTotal": 100,
    "TotalFee": 0,
    "TotalReceivable": 0,
    "CreatedTime": "2023-07-12T07:34:49.743",
    "UpdatedTime": "2023-07-12T07:43:55.193",
    "CurrencyCode": "USD",
    "CurrencySymbolic": "$",
    "TaxPercent": 0,
    "TaxAmount": 0,
    "Status": "Paid",
    "StatusDescription": "Paid"
  },
  "StatusCode": 200,
  "Message": "Success"
}

404 Not Found

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 404,
  "Message": "Not Found"
}

401 Unauthorized

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 401,
  "Message": "Unauthorized"
}

403 Forbidden

{
  "Data": null,
  "Errors": null,
  "Meta": null,
  "StatusCode": 403,
  "Message": "Forbidden"
}

[GET] Query Invoice Detail

Table of Contents

Changelogs

API Definition

Request

Response