https://api.payload.co/invoices
Nested Objects
https://api.payload.co/invoices/{id}/attachments
https://api.payload.co/invoices/{id}/billing_schedule
https://api.payload.co/invoices/{id}/customer
https://api.payload.co/invoices/{id}/items
https://api.payload.co/invoices/{id}/processing_settings
Example
{
"id": "inv_nMENQJ0xycKaRckyQanqxiI9",
"object": "invoice",
"amount_due": 760.28,
"attachments": [],
"attrs": {},
"billing_schedule_id": "bscd_1cXTaRqYJnxu3GbkCvxe25kYP",
"created_at": "2022-02-02 21:11:48",
"customer_id": "acct_8g1p1slcpEeJfLFGuraMmCAR",
"description": "string",
"due_date": "2022-02-02",
"items": [],
"modified_at": "2022-02-02 21:11:48",
"paid_timestamp": "2022-02-02",
"processing_id": "acct_1tjNtVR4QzpbsRbC50LFXI3hN",
"processing_settings_id": "ps_1BWVWQbbELTbCWNQNN7vSQNdN",
"status": "draft",
"total_due": 424.3,
"total_paid": 499.94,
"type": "string",
"billing_contact": {
"city": "string",
"email": "string",
"name": "string",
"postal_code": "string",
"state_province": "string",
"street_address1": "string"
}
}
Attributes | Description |
---|---|
id string readonly |
Object ID |
object string readonly |
Value: invoice |
amount_due number readonly |
Remaining amount due |
attachments list |
Array of associated Invoice Attachment objects |
attrs json |
Custom object attributes |
billing_schedule_id id |
ID of the associated Billing Schedule object |
created_at datetime readonly |
Timestamp object was created |
customer_id id required |
ID of the associated Customer Account object |
description string |
Description of the invoice |
due_date date required |
Date the invoice is due |
items list |
Array of associated Line Item objects |
modified_at datetime readonly |
Timestamp object was last updated |
paid_timestamp date readonly |
Timestamp invoice was fully paid |
processing_id id |
ID of the associated Processing Account object |
processing_settings_id id readonly |
ID of the processing settings object |
status string |
Values: draft open unpaid partially_paid paid canceled |
total_due number readonly |
Total amount due |
total_paid number readonly |
Total amount paid |
type string |
Arbitrary type classification |
billing_contact: | |
---|---|
city string readonly |
City of the billing contact |
email string readonly |
Email of the billing contact |
name string readonly |
Name of the billing contact |
postal_code string readonly |
Zipcode of the billing contact |
state_province string readonly |
State of the billing contact |
street_address1 string readonly |
Street address of the billing contact |