Skip to main content
GET
/
v1
/
financial_documents
List financial documents
curl --request GET \
  --url https://api.scribe-mail.com/v1/financial_documents \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "number": "<string>",
      "total_amount_cents": 123,
      "stripe_receipt_url": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "period_start": "2023-11-07T05:31:56Z",
      "period_end": "2023-11-07T05:31:56Z",
      "file": {
        "url": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "byte_size": 123
      },
      "receipt": {
        "url": "<string>",
        "filename": "<string>",
        "content_type": "<string>",
        "byte_size": 123
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123,
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
page
integer
​
limit
integer

Response

Success

​
data
object[]
required
​
pagination
object
required

Offset (page/limit) pagination. The single pagination shape returned by every paginated list endpoint in the public API.