Skip to main content
POST
/
paymentHistory
Get Payment Reports API
curl --request POST \
  --url https://stagingstores.xoxoday.com/chef/v1/oauth/api/paymentHistory \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "plumProAPI.mutation.paymentHistory",
  "tag": "plumProAPI",
  "data": {
    "startDate": "2024-01-01",
    "endDate": "2024-01-30",
    "limit": 100,
    "page": 1
  }
}
'
{
  "data": {
    "invoice_number": 123,
    "reference_id": 123,
    "date": "<string>",
    "reason": "<string>",
    "adjusted_amount": 123,
    "closing_balance": 123,
    "transaction_status": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://help-plum.xoxoday.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Get Payment Report API Schema

ParameterTypeDescription
startDateStringthe start date of the report
endDateStringthe end date to which the report is required
limitIntegerthe number of entries that are required
pageIntegerdefine the pagination to extract the report

​
Response

{
  "data": {
    "h-0": "Parameter",
    "h-1": "Type",
    "h-2": "Description",
    "0-0": "invoice_number",
    "0-1": "Integer",
    "0-2": "This parameter provides the unique Invocie number  \nwhenever a Invoice is generated",
    "1-0": "reference_id",
    "1-1": "Integer",
    "1-2": "This parameter provides Order reference ID for any  \ndeductions or refunds",
    "2-0": "date",
    "2-1": "string",
    "2-2": "This parameter provides the transaction date",
    "3-0": "reason",
    "3-1": "string",
    "3-2": "This parameter provides the reason of the  \ntransaction like Funds added, Refunded, Brand  \nVoucher Issued",
    "4-0": "adjusted_amount",
    "4-1": "Integer",
    "4-2": "This parameter provides the information on amount  \nadded or deducted from the Balance",
    "5-0": "closing_balance",
    "5-1": "Integer",
    "5-2": "This parameter provides the information on the  \nclosing balance after every transaction",
    "6-0": "transaction_status",
    "6-1": "String",
    "6-2": "This provides information if the transaction status is  \neither Cancelled or Complete"
  },
  "cols": 3,
  "rows": 7,
  "align": [
    "left",
    "left",
    "left"
  ]
}
```json

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <access_token>

Body

application/json
​
query
enum<string>
default:plumProAPI.mutation.paymentHistory
required
Available options:
plumProAPI.mutation.paymentHistory
​
tag
enum<string>
default:plumProAPI
required
Available options:
plumProAPI
​
data
object
required

Response

Payment report returned.

​
data
object