Agency Finance

Get invoices

get

https://test.swooveapi.comhttps://live.swooveapi.com

/agency/finance/invoices/

Returns a paginated list of invoices associated with the agency.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

from_dateinteger · int64Optional

Start of date range in epoch milliseconds

to_dateinteger · int64Optional

End of date range in epoch milliseconds

page_numberintegerOptional

Page number

Default: 1

limitintegerOptional

Number of invoices per page

Default: 10

Responses

200

Successfully retrieved invoices

application/json

successbooleanOptional

status of request true for success and false for failed request

Default: true

codeinteger · int32Optional

code for reason for failure

Default: 200

messagestringOptionalDefault: Estimate completed

401

Unauthorized

500

Something went wrong

get

/agency/finance/invoices/

HTTPcURLJavaScriptPython

GET /agency/finance/invoices/ HTTP/1.1
Host: test.swooveapi.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "code": 200,
  "message": "Estimate completed",
  "responses": {
    "total": 1,
    "limit": 1,
    "page": 1,
    "pages": 1,
    "docs": [
      {
        "_id": "text",
        "source": "DELIVERY",
        "status": "PAID",
        "is_requested": true,
        "discount": null,
        "currency_code": "GHS",
        "currency_symbol": "₵",
        "currency_name": "Ghanaian Cedis",
        "payer_id": "text",
        "receiver_id": "text",
        "agency_id": "text",
        "trip_id": "text",
        "description": "text",
        "redirect_url": "text",
        "estimate_id": "text",
        "individual_delivery_id": "text",
        "payment_type": "CASH",
        "option_id": "text",
        "subscription_id": "text",
        "category": "DELIVERY FEES",
        "payment_link": "text",
        "customer_name": "text",
        "customer_email": "text",
        "customer_mobile": "text",
        "referrence_id": "text",
        "channel": "text",
        "is_deleted": true,
        "date_created": 1,
        "date_changed": 1,
        "price": 1,
        "balance": 1,
        "delivery": {
          "pickup": {
            "type": "text",
            "value": "text",
            "contact": {
              "name": "text",
              "mobile": "text",
              "email": "text"
            },
            "country_code": "GH",
            "lat": 1,
            "lng": 1,
            "location": "text"
          },
          "dropoff": {
            "type": "text",
            "value": "text",
            "contact": {
              "name": "text",
              "mobile": "text",
              "email": "text"
            },
            "country_code": "GH",
            "lat": 1,
            "lng": 1,
            "location": "text"
          },
          "items": [
            {
              "itemName": "text",
              "itemQuantity": 1,
              "itemCost": 1,
              "description": "text",
              "itemImages": [
                "text"
              ],
              "itemWeight": 1,
              "is_fragile": false,
              "dimensions": {
                "x": 1,
                "y": 1,
                "z": 1
              }
            }
          ],
          "contact": {
            "name": "text",
            "mobile": "text",
            "email": "text"
          },
          "instructions": "text",
          "reference": "text",
          "estimate_id": "text"
        }
      }
    ]
  }
}