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

Status

colour	Green
title	GET

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

Response

Info200 Success

Allow user to get their invoice by invoice number

Changelogs

Version	Date	Changes by	Description of change
V1.0

Mar 29,

10 Oct 2024

Que Nguyen

Tam Tran

Add

Added Table of Contents.

Add

Added 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

Order Resource

InvoiceNumber string

Invoice unique number

Quantity decimal

Quantity

Status object

Value: Value of Enum
Description: Description of Enum

Client Invoice Status (Unpaid, WaitingForConfirm, Paid, Expired, Cancelled, Refunded, PartialPayment, PartialPaid, PaymentFollowUp, OfflineManual)

IssuedDate DateTime

Isssued Date

DueDate DateTime

Due Date

PaidDate DateTime

Paid Date

CreatedTime DateTime

Invoices created time

UpdatedTime DateTime

Invoices updated time

CurrencyCode text

Current Code (USD, ..)

FeeCodeNumber text

Fee Code Number

PayerTaxPercentage decimal

Payer tax percentage

PayeeTaxPercentage decimal

Payee tax percentage

Payer:CompanyName text

Payer’s company name

Payer:RegistrationNumber text

Payer’s registration number

Payer:Address text

Payer’s address

Payer:Country text

Payer’s country

Payee:CompanyName text

Payer’s company name

Payee:RegistrationNumber text

Payer’s registration number

Payee:Address text

Payer’s address

Payee:Country text

Payer’s country

MainInvoice:Total decimal

Total price in invoice

MainInvoice:SubTotal decimal

Sub Total price in invoice

MainInvoice:PayeeTaxAmount decimal

Payee Tax Amount in primary invoice

MainInvoice:PayerTaxAmount decimal

Payer Tax Amount in primary invoice

MainInvoice:Items[n]:Quantity decimal

Quantity of rec

MainInvoice:Items[n]:UnitPrice decimal

Price

MainInvoice:Items[n]:TotalPrice decimal

Quantity x UnitPrice

MainInvoice:Items[n]:Description text

Description

MainInvoice:Items[n]:TransactionDate datetime

Transaction Date

MainInvoice:Items[n]:TransactionId text

Transaction Id

MainInvoice:PayerSubtotal text

Payer sub total in primary invoice

MainInvoice:PayeeSubtotal text

Payee sub total in primary invoice

MainInvoice:PayerSubtotalWithTax text

Payer sub total include tax in primary invoice

MainInvoice:PayeeSubtotalWithTax text

Payer sub total include tax in primary invoice

SplitInvoices array

Secondary invoice (have same attribute with MainInvoice)

Code Block

language	json

{
        "DataInvoiceNumber": {"INV-REAR-2024-09-27-00006",
        "FeesQuantity": 020.000000,
        "TaxIssuedDate": 8,"2024-09-27T00:00:00.0000000Z",
        "TaxPercentageDueDate": 0.08"2024-10-01T15:59:59.9999999Z",
        "PaidDate": null,
        "ReceiverStatus": {
            "Value": "Unpaid",
     "CompanyName       "Description": "REDEX Pte. Ltd.",Unpaid"
        },
        "CreatedTime": "2024-09-27T16:30:14.693",
        "UpdatedTime": "2024-09-27T16:30:14.693",
        "RegistrationNumberCurrencyCode": "201834016KUSD",
        "AddressFeeCodeNumber": null,
        "Blk 71 Ayer Rajah Crescent""PayerTaxPercentage": 0.0000,
        "PayeeTaxPercentage": 0.0000,
        "BankNamePayer": "Oversea-Chinese Banking Corporation Limited", {
            "CompanyName": "1234",
            "PaymentTypeRegistrationNumber": "SwiftCode1234",
            "PaymentTypeDescriptionAddress": "Outside USzxcvb",
            "CurrencyCountry": "USD",Åland Islands"
        },
        "Payee": {
            "BankAccountNumberCompanyName": "601278732201REDEX Pte. Ltd.",
            "ACHRoutingNumberRegistrationNumber": null"201834016K",
            "BankAccountNameAddress": "Oversea-Chinese Banking Corporation Limited",Blk 71 Ayer Rajah Crescent",
            "BankAccountTypeCountry": "Checking"Singapore"
        },
        "BankAccountTypeDescriptionMainInvoice": "Checking"{
            "Total": 40.00,
      "SwiftCode": "OCBCSGSGXXX"
    },      "SubTotal": 40.00,
            "PayeeTaxAmount": 0.00,
            "PayerTaxAmount": 0.00,
            "Items": [
                {
                  "DeviceName  "Quantity": 20.000000,
                    "UnitPrice": 1.50,
                    "TotalPrice": 30.00,
                    "Description": "T-RECSolar VNTSTK3R2",Singapore v2024 Solar I-REC (Bid 20 Qty @ USD 1.5000)",
                    "VintageTransactionDate": 2023,"2024-09-27T08:15:35.4800000Z",
              "CountryCode      "TransactionId": "VN"EX2024092708153565670626"
                },
                {
                    "Quantity": 10,1.000000,
                    "UnitPrice": 10.00,
                    "TotalPrice": 100,10.00,
                    "Description": "Buyer Processing Fee (Min USD 10.00)",
                    "TransactionDate": "2024-09-27T16:30:14.7000000Z",
                    "TransactionId": null
                }
            ],
            "InvoiceNumber": "INV-REAP-2023-07-12-00028",
    "Quantity": 10,"PayerSubtotal": 0,
            "PayeeSubtotal": 40.00,
            "PayerSubtotalWithTax": 0.00,
            "PayeeSubtotalWithTax": 40.00
        },
        "SplitInvoices": null
    }

API Definition

Status

colour	Green
title	GET

/public/v2/invoices/{invoiceNumber}

Request

Headers

Content-Type	`application/json`
Authorization	`Bearer {{access_token}}`

Query Parameters

InvoiceNumber - text

The Invoice Number of Invoice

Code Block
curl --location 'https://uat-api.redex.eco/public/v2/invoices/INV-REAR-2024-09-27-00006' \ --header 'accept: application/json' \ --header 'Authorization: Bearer {{access_token}}'

Response

Response Body

Data object collection - Order Resource

A collection of objects - Order Resource

Errors list of error objects

Please see "Getting Started - #Error Object" for more details

请查看Getting Started - #Error Object以获得更多信息。

Meta pagination resource

Return Pagination Resource

返回分页信息

StatusCode integer

Http Status codes standard. Example 200, 201, 400, 422.

http状态码，如200，201，400, 422

Message text

Response message: Success or error message.

返回成功或错误的信息。

Info
200 Success

Code Block

language	json

{
    "Data": {
        "InvoiceNumber": "INV-REAR-2024-09-27-00006",
        "TotalQuantity": 10820.000000,
        "IssuedDate": "20232024-0709-12T0727T00:3400:4900.35354690000000Z",
        "DueDate": "20232024-0710-21T2301T15:59:59.99999999999999Z",
        "PaidDate": null,
        "Status": {
            "Value": "Unpaid",
            "Description": "Unpaid"
        },
        "CreatedTime": "2024-09-27T16:30:14.693",
"2023-07-12T07:43:25        "UpdatedTime": "2024-09-27T16:30:14.693",
        "TypeCurrencyCode": "TradingUSD",
        "TypeDescriptionFeeCodeNumber": null,
        "PayerTaxPercentage": 0.0000,
        "PayeeTaxPercentage": 0.0000,
        "Payer": {
            "CompanyName": "1234",
            "RegistrationNumber": "1234",
            "Address": "zxcvb",
            "Country": "Åland Islands"
        },
        "Payee": {
            "CompanyName": "REDEX Pte. Ltd.",
            "RegistrationNumber": "201834016K",
            "Address": "Blk 71 Ayer Rajah Crescent",
            "Country": "Singapore"
        },
        "MainInvoice": {
            "Total": 40.00,
            "SubTotal": 100,40.00,
            "TotalFeePayeeTaxAmount": 0.00,
    "TotalReceivable        "PayerTaxAmount": 0.00,
    "CreatedTime        "Items": [
                {
                    "Quantity": 20.000000,
                    "UnitPrice": 1.50,
                    "TotalPrice": 30.00,
                    "Description": "Singapore v2024 Solar I-REC (Bid 20 Qty @ USD 1.5000)",
                    "TransactionDate": "20232024-0709-12T0727T08:3415:4935.7434800000Z",
       "UpdatedTime             "TransactionId": "2023-07-12T07:43:55.193","EX2024092708153565670626"
                },
                {
                    "Quantity": 1.000000,
                    "UnitPrice": 10.00,
                    "TotalPrice": 10.00,
                    "CurrencyCodeDescription": "Buyer Processing Fee (Min USD 10.00)",
     "CurrencySymbolic               "TransactionDate": "$2024-09-27T16:30:14.7000000Z",
    "TaxPercent": 0                "TransactionId": null
                }
            ],
    "TaxAmount        "PayerSubtotal": 0,
            "StatusPayeeSubtotal": "Paid",40.00,
            "PayerSubtotalWithTax": 0.00,
      "StatusDescription      "PayeeSubtotalWithTax": "Paid"
  },
  "40.00
        },
        "SplitInvoices": null
    },
    "Meta": null,
    "Errors": null,
    "StatusCode": 200,
    "Message": "Success"
}

Warning

404 Not Found

400 Bad Request

Code Block

language	json

{
  "Data": null
  "StatusCode": 400,
  "Errors": null,
  "Meta": null,
  "Message": "Bad Request"
}

Warning
422 Unprocessable Entity

Code Block

language	json

{
  "Data": null
  "StatusCode":

404

402,
  "Errors": null,
  "Meta": null,
  "Message": "

Not

Unprocessable

Found

Entity"
}

Warning
401 Unauthorized

Code Block

language	json

{
  "Data": null,
  "

Errors

StatusCode":

null

401,
  "

Rate limit

Rate Limit Algorithm: Fixed Window

In fixed window rate limiting, a fixed time window (e.g., one minute, one hour) is used to track the number of requests or actions allowed within that window. Requests exceeding the limit are either rejected or throttled until the window resets.

Rate Limiting Overview

Our API employs rate limiting to ensure fair usage and protect the performance and availability of the service. Combination of Global Policy and Operation Policy

Global Policy

Rate Limit: 3000 requests per 5 minute(s)
Renewal Period: 300 second(s)
Key: IP Address
Increment Condition: Any Request

Operation Policy

Rate Limit: 10 requests per 10 seconds(s)
Renewal Period: 10 second(s)
Key: accound-id business account Id.
Increment Condition: Any Request.

Rate Limit Details

Rate Limit by Key:
1. Key: This ensures that rate limits are applied uniquely for each business account id.
2. Request Limit: Each key is allowed to make up to 10 requests per 10 seconds.
3. Reset Interval: The limit resets every 10 seconds.
Response Headers:
1. Retry-After: Sent when the rate limit is exceeded, indicating how long to wait before making another request.

Exceeding the Rate Limit

When the rate limit is exceeded, the API will return a 429 Too Many Requests status code. The response will include a Retry-After header specifying the number of seconds to wait before making a new request.

Example Response When Rate Limit is Exceeded

Code Block

language	json

HTTP/1.1 429 Too Many Requests
Retry-After: 10
Content-Type: application/json
{
    "Data": null,
    "Errors": null,
    "StatusCode":

403

429,
    "Message": "Rate limit

"Forbidden"

exceeded",
    "Meta": null
}

Versions Compared

Old Version 19

New Version 20

Key

Request

Response

Table of Contents

Changelogs

API Definition

Order Resource

API Definition

Request

Headers

Query Parameters

Response

Rate limit

Rate Limiting Overview

Global Policy

Operation Policy

Rate Limit Details

Exceeding the Rate Limit

Example Response When Rate Limit is Exceeded

Page Comparison

Versions Compared

Old Version 19

New Version 20

Key

Request

Response

Table of Contents

Changelogs

API Definition

Order Resource

API Definition

Request

Headers

Query Parameters

Response

Rate limit

Rate Limiting Overview

Global Policy

Operation Policy

Rate Limit Details

Exceeding the Rate Limit

Example Response When Rate Limit is Exceeded