Invoice
When requesting an Invoice, use the requestJSON to pass the Invoice data, and the response will have responseJSON which stores the Invoice response returned by Breadwinner Payments.
The Invoice object has the following properties.
Invoice
Field Name | Data Type | Description |
processorCustomerId* | String | Customer Id in the Processor (Find this) |
dueDate | DateTime | Conditionally required. "dueDate" or "daysUntilDue" value is required to create and send the Invoice. |
daysUntilDue | Integer | Conditionally required. "dueDate" or "daysUntilDue" value is required to create and send the Invoice. |
coupon | String | |
invoiceStatus | String | We currently support SEND_TO_CUSTOMER. |
pendingInvoiceItemsBehavior | String | One of include, exclude, or include_and_require, by default set to exclude the pending items on Customer. |
description | | |
footer | | |
items* | List (items) | At least one line item is required to create an Invoice. |
Items
Field Name | Data Type | Description |
processorPriceId | String | Id of the specific Product/Price that is getting added to the Subscription. Note: this is the Id in the Processor not in Salesforce. |
quantity | Integer | |
amount | Decimal | readOnly field |
unitAmountDecimal | Decimal | readOnly field |
chargeCurrency | String | readOnly field |
description | String | readOnly field |
name | String | readOnly field |
invoice | String | readOnly field |
salesforcePriceId | String | readOnly field |
salesforceId | String | readOnly field |
salesforceSubscriptionId | String | readOnly field |
procesorSubscriptionId | String | readOnly field |
processorId | String | readOnly field |
unitAmount | Decimal | readOnly field |
