masstack

V2
V3
V4
API Overview Resources Schemas

Invoices

Access to invoices

Parameters

Name In Type Required Description
orgId path string true organization name
accountId path integer(int64) true account identifier
start_date query string(date) false start date query with format yyyy-mm-dd
end_date query string(date) false end date query with format yyyy-mm-dd

Request example

1
2
3
4
5


curl -X GET https://customers.sta.masstack.com/v2/orgs/telco/accounts/214748364/invoices?start_date='1970-01-01'&end_date='1970-01-01' \
  -H "Accept: application/json" \
  -H "x-auth-roles: API_KEY"

Responses

Code Meaning Description Schema
200 OK successful operation InvoiceInfoList
400 Bad Request Invalid request body ErrorMessage
404 Not Found Resource not found ErrorMessage
405 Method Not Allowed Method not allowed None

200 - instance of InvoiceInfoList

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
  "account_id": 0,
  "period_date": {
    "start_date": "2020-05-01",
    "end_date": "2020-05-27"
  },
  "invoices": [
    {
      "value": 47.89,
      "delivery_mode": "yosoymas",
      "date": "2017-09-15T22:00:00Z",
      "pay_date": "2017-09-15T22:00:00Z",
      "number": "MM12123445",
      "path": "/path/to/invoices/20120716/XYZ_AB12345.pdf",
      "status": {
        "id": 2,
        "value": "PAGADO"
      },
      "cycle": {
        "start_date": "2030-01-01T12:13:11Z",
        "end_date": "2030-01-17T12:13:11Z"
      }
    }
  ]
}
Name Type Required Description
account_id integer(int64) true account identifier
period_date PeriodDate true none
invoices [InvoiceInfoDetail] true none

Endpoints

Signups

    Users

      Accounts

        Invoices

          Terms

            Payment info

              Account migrations

                Subscriptions

                  Products

                    Services

                      Bonuses

                        Promotions

                          Barrings

                            Consumption

                              Workorders

                                Penalties