Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

Get all invoice items.

Resource information

Response format(s)

JSON

Requires authentication?

Yes using token

Request Header

Name

Value

Content-Type

application/json

Authorization

{{token}}

Parameters

Statuses

  • array[string]

  • query

Filter the items by statuses

  • Unpaid

  • Paid

  • Expired

  • Cancelled

  • Sending

  • Refunded

  • PaidFail

Types

  • array[string]

  • query

Filter the items by types

  • Trading

  • Retirement

  • DeListing

TransactionType

  • string

  • query

Filter the items by transaction type

  • AccountsPayable

  • AccountsReceivable

Search

  • string

  • query

Enter search data that can be used to search on each items. You can search by:

  • Invoice Number

CurrentPage

  • numeric

  • query

Request field for pagination. The Page that you wish to view

ItemsPerPage

  • numeric

  • query

The total items that return in the response

OrderBy

  • string

  • query

Sorting field, Default sorting is get all items sort by CreatedDate Desc

Values:

  • CreatedDate

  • To Be Updated

IsDecending

  • boolean

  • query

Used in OrderBy

default: false

Returns

Returns all invoice items

Response Header

Content-Type

application/json

Response Body

Field

Type

Description

InvoiceNumber

string

Invoice Number

Quantity

decimal(18,6)

Total

decimal(18,6)

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)

TaxAmount

decimal(18,6)

FeeCodeNumber

string

Status

string

StatusDescription

string

CreatedTime

DateTime

Date time utc format

UpdatedTime

DateTime

Date time utc format

CurrentPage

int

TotalPage

int

TotalRow

int

PageSize

int

Request

GET /public/v2/invoices

Request

?Statuses=Paid&Statuses=Sending&Types=Trading&TransactionType=AccountsPayable

Response

200 Success

{
  "Data": {
    "CurrentPage": 1,
    "TotalPage": 2,
    "PageSize": 50,
    "TotalRow": 100,
    "Results": [
    {
      "InvoiceNumber": "INV-REAP-2023-07-13-00001",
      "Quantity": 90,
      "Total": 1240.29,
      "IssuedDate": "2023-07-13T03:49:46.1656485",
      "DueDate": "2023-07-22T23:59:59.9999999",
      "PaidDate": null,
      "Type": "Trading",
      "TypeDescription": "Trading",
      "SubTotal": 1176.3,
      "TotalFee": 27.8865,
      "TotalReceivable": 1240.2835,
      "CreatedTime": "2023-07-13T03:49:46.43",
      "UpdatedTime": "2023-07-13T03:50:22.88",
      "CurrencyCode": "USD",
      "CurrencySymbolic": "$",
      "TaxPercent": 0.08,
      "TaxAmount": 91.87,
      "FeeCodeNumber": null,
      "Status": "Unpaid",
      "StatusDescription": "Unpaid",
      }
    ]
  },
  "StatusCode": 200,
  "Message": "Success"
}

400 Bad Request

{
  "Data": null,
  "StatusCode": 400,
  "Message": "Bad request"
}

401 Unauthorized

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

403 Forbidden

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

  • No labels