Create an invoice

POST /api/v1/invoices

This endpoint creates an invoice that reflects the insurance premium owed by the contractor for the specified pay period.

application/json

Body

contractor string Required

ID of the contractor
gross_pay integer Required

The gross pay that the contractor earned in the last pay period.
job string Required

ID of the job that the contractor was paid to do.
paycycle_enddate integer Required

Pay period end date.
paycycle_startdate integer Required

Pay period start date.

Responses

201 application/json

Returns the invoice object if the post succeeded.
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.

POST /api/v1/invoices

curl \
 --request POST 'https://api.1099policy.com/api/v1/invoices' \
 --header "Content-Type: application/json" \
 --data '{"$ref":"#/components/examples/invoice"}'

Request example

{
  "$ref": "#/components/examples/invoice"
}

Response examples (201)

{
  "contractor": "cn_Ehb3bYa",
  "created": 1646818364,
  "gross_pay": 250000,
  "id": "in_4RviYgc2Wt",
  "job": "jb_jsb9KEcTpc",
  "paycycle_enddate": 1678334737,
  "paycycle_startdate": 1646818364,
  "premium_due": 4325
}