List all invoices

GET /api/v1/invoices

You can list all invoices, or list the invoices for a specific contractor. The invoices are returned sorted by creation date, with the most recently created invoices appearing first.

Query parameters

  • limit integer

    A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

    Minimum value is 1, maximum value is 100. Default value is 10.

  • starting_after string

    A cursor for use in pagination. starting_after is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with in_fOo123, your subsequent call can include starting_after=in_fOo123 in order to fetch the next page of the list.

  • ending_before string

    A cursor for use in pagination. ending_before is an invoice ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with in_bAr123, your subsequent call can include ending_before=in_bAr123 in order to fetch the previous page of the list.

Responses

  • • 200 application/json

    Returns an array of invoice objects. If no more invoices are available, the resulting array will be empty.

    Hide response attributes Show response attributes object
    • contractor string

      ID of the contractor.

    • created integer(int64)

      Time at which the object was created. Measured in seconds since the Unix epoch.

    • gross_pay integer

      The gross pay that the contractor earned in the last pay period.

      A positive integer representing the gross pay (e.g., 15000 cents to charge $150.00). The minimum amount is 1000 cents US. The maximum amount is 100000000 cents US ($1,000,000).

      Minimum value is 1000, maximum value is 100000000.

    • id string
    • job string

      ID of the job that the contractor was paid to do.

    • paycycle_enddate integer(int64)

      Pay period end date. Measured in seconds since the Unix epoch.

    • paycycle_startdate integer(int64)

      Pay period start date. Measured in seconds since the Unix epoch.

    • premium_due integer

      Premium due for pay cycle. Calculated as a percentage of gross pay for the period.

      A positive integer representing the premium due (e.g., 150 cents to charge $1.50). The minimum amount is 100 cents US.
GET /api/v1/invoices 
curl \
 -X GET https://api.1099policy.com/api/v1/invoices
Response examples (200) 
[
  {
    "contractor": "cn_Ehb3bYa",
    "created": 1646818364,
    "gross_pay": 250000,
    "id": "in_4RviYgc2Wt",
    "job": "jb_jsb9KEcTpc",
    "paycycle_enddate": 1678334737,
    "paycycle_startdate": 1646818364,
    "premium_due": 4325
  }
]