Invoices

https://api.payload.com/invoices

Nested Objects

https://api.payload.com/invoices/{id}/attachments

https://api.payload.com/invoices/{id}/billing_schedule

https://api.payload.com/invoices/{id}/customer

https://api.payload.com/invoices/{id}/items

https://api.payload.com/invoices/{id}/payment_links

https://api.payload.com/invoices/{id}/processing

https://api.payload.com/invoices/{id}/processing_settings

Example

{
  "id": "inv_1wpwi8r6mQNOzNicatRxv40Vc",
  "object": "invoice",
  "amount_due": 157.83,
  "attachments": [],
  "attrs": {},
  "autopay_allowed": true,
  "billing_schedule_id": "bscd_WP8HqmJqxhYqQ4MHmy8lWGMp",
  "created_at": "2024-08-21 13:35:03",
  "customer_id": "acct_8vshIS6CIPiZD5tfHM7ahgK0",
  "description": "string",
  "due_date": "2024-08-21",
  "external_uid": "string",
  "items": [],
  "modified_at": "2024-08-21 13:35:03",
  "number": "string",
  "paid_timestamp": "2024-08-21",
  "processing_id": "acct_1uVz9uQtt7OU3gTTCYrpuvKvM",
  "processing_settings_id": "ps_1c7pmfUsvWFyemlBPw6jRdkOg",
  "status": "draft",
  "total_due": 612.1,
  "total_paid": 659.21,
  "type": "string",
  "billing_contact": {
    "city": "string",
    "email": "string",
    "name": "string",
    "phone": "string",
    "postal_code": "postal_code",
    "state_province": "string",
    "street_address1": "string",
    "street_address2": "string",
    "website": "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
`autopay_allowed` bool	Allow or disable automatic payments
`billing_schedule_id` id	ID of the associated Billing Schedule object
`created_at` datetime readonly	None
`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
`external_uid` string	Optional unique external id used for lookup and upsert
`items` list	Array of associated Line Item objects
`modified_at` datetime readonly	None
`number` string	Incrementing invoice number
`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 closed sync
`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
`phone` string readonly	Phone number of the billing contact
`postal_code` postal_code 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
`street_address2` string readonly	Street address 2 of the billing contact
`website` string readonly	Website of the billing contact