InvoiceData Object Model
API Basics
Pay In Endpoints
- MoneyIn
- Subscription
- TokenStorage
- Invoice
- LineItem
- PaymentLink
- PaymentMethodDomain
- HostedPaymentPages
- Cloud
- Wallet: Apple Pay
Pay Out Endpoints
- MoneyOut
- Bill
Pay Ops Endpoints
- Templates
- Boarding
- Chargebacks and ACH Returns
- Entities
- Notification
- Query
- Statistic
- Export
- Import
InvoiceData Object Model
Object model for the InvoiceData object
The schema is of type object
.
Was this page helpful?
{
"customerData": {
"customerId": 4440,
"firstName": "John",
"lastName": "Doe",
"company": "Sunshine LLC",
"customerNumber": "3456-7645A",
"billingAddress1": "123 Walnut Street",
"billingAddress2": "STE 900",
"billingCity": "Johnson City",
"billingState": "Johnson City",
"billingZip": "37615",
"billingCountry": "US",
"billingPhone": "5555555555",
"billingEmail": "example@email.com",
"shippingAddress1": "123 Walnut St",
"shippingAddress2": "STE 900",
"shippingCity": "Johnson City",
"shippingState": "TN",
"shippingZip": "37619",
"shippingCountry": "US",
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
},
"identifierFields": [
"email"
]
},
"invoiceData": {
"invoiceNumber": "INV-2345",
"invoiceDate": "2024-07-01",
"invoiceDueDate": "2024-07-01",
"invoiceType": 0,
"invoiceEndDate": "2024-07-01",
"invoiceStatus": 1,
"frequency": "monthly",
"paymentTerms": "PIA",
"termsConditions": "Must be paid before work scheduled.",
"notes": "Example notes.",
"tax": 2.05,
"discount": 10,
"invoiceAmount": 105,
"freightAmount": 10,
"dutyAmount": 0,
"purchaseOrder": "PO-345",
"firstName": "Chad",
"lastName": "Mercia",
"company": "ACME, INC",
"shippingAddress1": "123 Walnut St",
"shippingAddress2": "STE 900",
"shippingCity": "Johnson City",
"shippingState": "TN",
"shippingZip": "37619",
"shippingCountry": "US",
"shippingEmail": "example@email.com",
"shippingPhone": "5555555555",
"shippingFromZip": "30040",
"summaryCommodityCode": "501718",
"items": [
{
"itemProductCode": "M-DEPOSIT",
"itemProductName": "Materials deposit",
"itemDescription": "Deposit for materials.",
"itemCommodityCode": "010",
"itemUnitOfMeasure": "SqFt",
"itemCost": 5,
"itemQty": 1,
"itemMode": 0,
"itemCategories": [
"<string>"
],
"itemTotalAmount": 123,
"itemTaxAmount": 7,
"itemTaxRate": 0.075
}
],
"attachments": {},
"AdditionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"scheduledOptions": {
"includePaylink": true,
"includePdf": true
}
}