Expenses API (1.0)

Expenses API

API to get and update expense reports

Download OpenAPI description
Languages
Servers
Mock server
https://developer.boyahq.com/_mock/expenses/
Boya API server
https://api.boyahq.com/v1/

Get all expenses

Request

Fetch business expenses

Query
fromdatestring(date)

yyyy-mm-dd

todatestring(date)

yyyy-mm-dd

pageinteger
Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Expenses Found

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Get Expenses Pending Review

Request

Get expenses pending review

Query
fromdatestring(date)

Start date (yyyy-mm-dd)

todatestring(date)

End date (yyyy-mm-dd)

pageinteger

Page number

Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses/review?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Get approved expenses

Request

Query
fromdatestring(date)

Start date (yyyy-mm-dd)

todatestring(date)

End date (yyyy-mm-dd)

pageinteger

Page number

Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses/accepted?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Get rejected expenses

Request

Query
fromdatestring(date)

Start date (yyyy-mm-dd)

todatestring(date)

End date (yyyy-mm-dd)

pageinteger

Page number

Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses/rejected?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Get recovered expenses

Request

Query
fromdatestring(date)

Start date (yyyy-mm-dd)

todatestring(date)

End date (yyyy-mm-dd)

pageinteger

Page number

Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses/recovered?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Get expenses with refunded payments

Request

Query
fromdatestring(date)

Start date (yyyy-mm-dd)

todatestring(date)

End date (yyyy-mm-dd)

pageinteger

Page number

Default 1
limitinteger

Number of items per page

Default 50
curl -i -X GET \
  'https://developer.boyahq.com/_mock/expenses/expenses/refunded?fromdate=2019-08-24&limit=50&page=1&todate=2019-08-24' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
docsArray of objects(Expense)
totalinteger
limitinteger
pageinteger
pagesinteger
Response
application/json
{ "docs": [ {} ], "total": 0, "limit": 0, "page": 0, "pages": 0 }

Update expense sync status

Request

Update sync status for one or more expenses

Bodyapplication/jsonrequiredArray [
transaction_refstringrequired

Reference ID of the transaction

]
curl -i -X PATCH \
  https://developer.boyahq.com/_mock/expenses/expenses/sync_status \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '[
    {
      "transaction_ref": "string"
    }
  ]'

Responses

Sync status updated successfully