Create an invoice

Securityapi_key or session_token

Request

Request Body schema: application/json

Create an invoice input

companyId	string (HashedId) <= 128 characters /^\w+$/
	object (InvoiceCreateInput)

Responses

200

An invoice response

401

API key is missing or invalid

403

Request is completely forbidden. API not provided or method and or endpoint not supported

404

404 Not found

429

429 too many requests response

500

Service Error

default

unexpected error response

post/invoice/create

Request samples

Payload
curl
JavaScript
Node.js
Python

application/json

{"companyId": "string",
"invoiceCreateInput": {"comments": "string",
"convFeeDisable": true,
"customFields": { },
"customerId": "string",
"departmentId": "string",
"description": "string",
"lineItems": [{"description": "string",
"isTaxable": true,
"productId": "string",
"qty": -999999999.99
}
],
"locationId": "string",
"payerEmail": "string",
"payerName": "string",
"payerPhone": "string",
"shiftId": "string",
"temporaryCustomerName": "string",
"workflowStatus": ""
}
}

Response samples

application/json

{"code": "Success",
"message": "string",
"invoice": {"amount": -999999999.99,
"attachmentCount": 6,
"authorizedAt": "2020-07-21 17:32:28Z",
"baseAmt": -999999999.99,
"comments": "string",
"company": {"id": "string",
"logoUrl": "string",
"name": "string",
"phone": "string",
"publicId": 999999999,
"type": ""
},
"convFee": -999999999.99,
"convFeeDisable": true,
"createdAt": "2020-07-21 17:32:28Z",
"customFields": { },
"customer": {"city": "string",
"companyId": "string",
"contactEmail": "string",
"contactPhone": "string",
"customerCompanyId": "string",
"id": "string",
"name": "string",
"nickname": "string",
"publicId": 999999999,
"state": "AL"
},
"customerId": "string",
"deletedAt": "2020-07-21 17:32:28Z",
"deletionReason": "",
"department": {"id": "string",
"locationId": "string",
"name": "string"
},
"depositStatus": "",
"description": "string",
"files": [{"fileId": "string",
"fileName": "string",
"invoiceFileId": "string",
"invoiceId": "string",
"type": ""
}
],
"id": "string",
"initialType": "",
"invoiceNumber": 999999999,
"lineItems": [{"cost": -999999999.99,
"description": "string",
"isTaxable": true,
"product": {"accountingProducts": [{"externalId": "string",
"featureType": "unknown"
}
],
"cost": -999999999.99,
"generalLedger": "string",
"id": "string",
"isTaxable": true,
"locationId": "string",
"name": "string",
"parentId": "string",
"parentPath": "string",
"selectType": "",
"type": "service",
"weight": 999999999
},
"productId": "string",
"qty": -999999999.99,
"type": "service"
}
],
"location": {"city": "string",
"companyId": "string",
"customFields": [{"deletedAt": "2020-07-21 17:32:28Z",
"id": "string",
"isRequired": true,
"isShownInList": true,
"name": "string",
"options": { },
"title": "string",
"type": ""
}
],
"id": "string",
"name": "string",
"state": "AL",
"timezone": "US/Hawaii"
},
"payerEmail": "string",
"payerName": "string",
"payerPhone": "string",
"paymentError": "",
"publicId": 999999999,
"receipt": {"url": "string"
},
"sentAt": "2020-07-21 17:32:28Z",
"shift": {"id": "string",
"locationId": "string",
"name": "string"
},
"status": "",
"subtype": "string",
"temporaryCustomerName": "string",
"timezone": "US/Hawaii",
"token": "string",
"type": "",
"updatedAt": "2020-07-21 17:32:28Z",
"user": {"avatarUrl": "string",
"email": "string",
"first": "string",
"id": "string",
"isVerified": true,
"last": "string",
"phone": "string"
},
"userId": "string",
"workOrderId": "string",
"workflowStatus": ""
}
}