Gets an existing invoice by ID.
The getInvoice()
function returns a Promise that resolves to the invoice
with the specified ID.
function getInvoice(id: string): Promise<Invoice>;
ID of the invoice to get.
import { Permissions, webMethod } from "wix-web-module";
import { invoices } from "wix-billing-backend";
export const getInvoice = webMethod(Permissions.Anyone, (id) => {
return invoices.getInvoice(id);
});
/* Promise resolves to:
*
* {
* "id":{
* "id": "411a5551-b0f6-4826-8a41-ebae2879f857",
* "version": 25
* },
* "status": "Draft",
* "number": "0000001",
* "title": "My Invoice",
* "currency": "USD",
* "customer": {
* "contactId": "4f7c6637-0657-4696-a00b-9bc2ae4e035d",
* "email": "john.doe@somedomain.com",
* "address": {
* "country": "USA",
* "subdivision": "NY",
* "city": "New York",
* "postalCode": "10011",
* "streetAddress": {
* "value": "235 W 23rd St",
* "type": "Name"
* },
* "addressLine": "someStreet",
* "formatted": "235 W 23rd St, New York, NY 10011, USA"
* },
* "billingAddress": {
* "country": "USA",
* "streetAddress": {
* "value": "235 W 23rd St",
* "type": "Name"
* },
* "addressLine": "235 W 23rd St, New York, NY 10011, USA",
* "postalCode": "10011",
* "subdivision": "NY",
* "city": "New York",
* "formatted": "235 W 23rd St, New York, NY 10011, USA"
* },
* "shippingAddress": {
* "country": "USA",
* "streetAddress": {
* "value": "235 W 23rd St",
* "type": "Name"
* },
* "addressLine": "235 W 23rd St, New York, NY 10011, USA",
* "postalCode": "10011",
* "subdivision": "NY",
* "city": "New York",
* "formatted": "235 W 23rd St, New York, NY 10011, USA"
* },
* "phone": "5555555555",
* "company": "Some Company",
* "companyId": "Some Company Id",
* "fullName": "John Doe",
* "firstName": "John",
* "lastName": "Doe"
* },
* "dates": {
* "issueDate": 2019-03-13T00:00:00.000Z,
* "dueDate": 2019-06-12T00:00:00.000Z,
* "lastSeenDate": 2019-03-14T00:00:00.000Z
* },
* "discount": {
* "value": 2.5,
* "type": "Fixed"
* },
* "lineItems":[
* {
* "id": "00001",
* "name": "Item 1",
* "description": "First Item",
* "price": 10.5,
* "quantity": 3,
* "taxes": [
* {
* "name": "tax name",
* "rate": 8.5,
* "code": "tax code"
* }
* ]
* },
* {
* "id": "00002",
* "name": "Item 2",
* "description": "Second Item",
* "price": 50,
* "quantity": 1,
* "taxes": [
* {
* "name": "tax name",
* "rate": 8.5,
* "code": "tax code"
* }
* ]
* }
* ],
* "locale": {
* "language": "en"
* },
* "payments": [{
* "id": "4j9q4o00-4205-8q83-003d-3ofd9d8wmf0w",
* "type": "offline",
* "amount": "25.50",
* "date": 2019-03-23T00:00:00.000Z"
* }],
* "totals": {
* "discountAmount": null,
* "taxedAmount": 6.93,
* "fees": [],
* "subtotal": 81.5,
* "total": 88.43
* },
* "dynamicTotals": {
* "paidAmount": 25.50,
* "balance": 62.39
* },
* "taxes": [
* {
* "name": "tax name",
* "rate": 8.5,
* "taxable": 81.5,
* "taxed": 6.93,
* "code": "tax code"
* }
* ],
* "metadata": {
* "notes": "Some note",
* "legalTerms": "Some legal terms",
* "sourceUrl": "http://legalurl.com",
* "source": "Some source",
* "sourceRefId": "Some source ref id"
* },
* "companyId": "Some company id",
* "wasSent": true
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.