get https://public.billsby.com/api/v1/rest/core/invoices/
Returned variables
| Variable name | Description |
|---|---|
| invoiceId | The unique identifier of the invoice in Billsby |
| customerEmail | The customer's registered email address |
| customerFirstName | The customer's first name |
| customerLastName | The customer's last name |
| customerUniqueId | The alphanumeric unique identifier of the customer in the Billsby platform |
| addressLine1 | First line of the address |
| addressline2 | Second line of the address |
| addressPostCode | Customer's postcode |
| addressCity | Customer's city |
| addressState | Customer's state |
| addressCountry | Customer's country |
| addressCountryCode | Customer's country iso-3 code |
| invoiceNumber | The unique ID for invoices |
| createdOn | The date on which the customer account was created |
| formattedAmount | The formatted amount of the invoice (i.e. £10 will show as 10.00) |
| amount | The amount of the invoice shown without decimals (i.e. £10 will show as 1000) |
| currency | The currency the invoice was issued in |
| status | The status of the customer; active or inactive |
| prorationAdjustment | The formatted amount of the proration (i.e. £10 will show as £10.00). This value can also be null. |
| prorationFactor | The percentage amount of the proration represented as a value between 0.0 and 1.0 (where 0.0 represents 0% and 1.0 represents 100%). This value can also be null. |
| subTotal | Total value of the invoice |
| taxTotal | Total value of tax associated with the invoice |
| taxes | Taxes applied to the subscription |
| invoiceType | Four types of invoice: - Renewal - OneTimeCharge - Refund - OneTimeCredit |
| subscriptionUniqueId | The uniques identifier of the subscription in the Billsby platform amount |
| planName | The name of the plan |
| billingPeriodStart | Start date of the billing period |
| billingPeriodEnd | End date of the billing period |
| units | The number of units included in the subscription |
| companyName | Name of the company |
| companyEmail | Email of the company |
| companyTaxNumber | Tax number set-up in your Billsby tax configuration. |
| companyDomain | Domain name set-up when creating your Billsby account. |
| companyPhoneNumberDialCountry | Company number dial country (eg United Kingdom) |
| companyPhoneNumberDialCode | Company number dial code (eg 0044) |
| companyPhoneNumber | Company's phone number |
| companyAddressLine1 | First line of the company's address |
| companyAddressLine2 | Second line of the company's address |
| companyCity | Company's city |
| companyState | Company's state |
| companyPostCode | Company postcode |
| companyCountry | Company's country |
| brandingLogo brandingLogoBackgroundColor brandingHighlightColor | Branding settings configured in Billsby |
| supportUrl | Support URL on the invoice |
| cardType | Type of card |
| cardLast4Digits | Last 4 digits of the Card Number |
| cardExpiryMonth | Expiry month of the Card Number |
| cardExpiryYear | Expiry year of the Card Number |
| refundableAmount | The amount that is currently refundable on the invoice. So if the invoice amount is £10 and £5 has already been refunded, this will be £5 and will show as 500. |
| footerCompanyName footerAddressLine1 footerAddressLine2 footerAddressState footerAddressCity footerAddressPostCode footerAddressCountryISO3 footerEmailAddress footerPhoneNumberDialCountry footerPhoneNumberDialCode footerPhoneNumber | Company information that is located on the footer of the invoice |
| supportContactHeading supportContactContent supportContactSupportUrl supportContactSupportUrlButtonText | Company support contact information that is located on the invoice. |
| isAdvertEnabled advertImageUrl advertLinkToUrl | Advertisement enablement and details on the invoice. |