v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Invoice

Retrieves the collection of Invoice resources.

get/invoices

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Invoice collection

idstring

unique identifier for this invoice note that no particular pattern in this field is guaranteed, only that this field is unique e.g. "quickbooks-34"

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

additionalTypestring nullable

An additional type for the item. This is a relationship between something and a class that the thing is in.

categorystring nullable

A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.

confirmationNumberstring nullable

a number that confirms the given order or payment has been received

customerIdstring nullable

party placing the order or paying the invoice

paymentMethodstring nullable

the name of the credit card or other method of payment for the order

paymentMethodIdstring nullable

An identifier for the method of payment used (e.g. the last 4 digits of the credit card).

paymentDueDatestring date-time nullable

The date the payment is due

providerstring nullable

The service provider, service operator, or service performer; the goods producer. Another party (a seller) may offer those services or goods on behalf of the provider. A provider may also serve as the seller.

potentialActionstring nullable

indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role

brokerstring nullable

An entity that arranges for an exchange between a buyer and a seller. In most cases a broker never acquires or releases ownership of a product or service involved in an exchange. If it is not clear whether an entity is a broker, seller, or buyer, the latter two terms are preferred.

minimumPaymentDueinteger nullable

the minimum payment required at this time

accountIdstring nullable

the identifier for the account the payment will be applied to

scheduledPaymentDatestring date-time nullable

the date the invoice is scheduled to be paid

billingPeriodstring nullable

the time interval used to compute the invoice in ISO 8601 duration format

statusstring nullable

the status of payment; whether the invoice has been paid or not

paymentStatusstring nullable

createdstring date-time nullable

The date and time the invoice was first created

modifiedstring date-time nullable

The date and time the invoice was last updated

subtotalinteger nullable

Total payment amount, before tax

taxAmountinteger nullable

Tax amount

currencyCodestring nullable

Currency code

invoiceNumberstring nullable

Invoice number

amountPaidinteger nullable

Amount paid so far

amountCreditedinteger nullable

The amount remaining that is due

customerNamestring nullable

The customer's name

customerMemostring nullable

billingEmailstring nullable

The customer's email

billingAddressTypestring nullable

billingAddressLine1string nullable

@ApiProperty( swaggerContext={"example"="4567 Finch St.", "required"=false}, openapiContext={"example"="4567 Finch St.", "nullable"=true})

billingAddressLine2string nullable

billingCitystring nullable

billingPostalCodestring nullable

shippingAddressTypestring nullable

shippingAddressLine1string nullable

shippingAddressLine2string nullable

shippingCitystring nullable

shippingPostalCodestring nullable

srcIdstring

the unique identifier of the source 3rd party integration

urlstring nullable

Invoice url

txnDatestring date-time nullable

Transaction date

jsonAddressstring nullable

Billing address in json format

subscriptionIdstring nullable

The ID of the subscription the invoice was prepared for

referenceNumberstring nullable

Reference number of sale order

balanceinteger nullable

Ending customer balance after the invoice is finalized

accountNamestring nullable

The name of the business associated with the invoice

purchaseOrderNuminteger nullable

Purchase order number

billingCountrystring nullable

Billing address country

totalAmountinteger nullable

Total amount of the invoice

billingStatestring nullable

State the billing address is addressed to

shippingCountrystring nullable

Country the shipping address is addressed to

shippingStatestring nullable

State the shipping address is addressed to

amountDueinteger nullable

The unpaid amount that is due on the invoice

Example response

[
  {
    "id": "quickbooks-34",
    "integration": "quickbooks",
    "category": "Spare Parts Division",
    "confirmationNumber": "2798-2929",
    "customerId": "672",
    "paymentMethod": "PayPal",
    "paymentMethodId": "3009",
    "paymentDueDate": "2020-10-22T19:30:17.697Z",
    "provider": "Amazon",
    "minimumPaymentDue": 2000,
    "accountId": "127362",
    "scheduledPaymentDate": "2021-10-22T19:30:17.697Z",
    "billingPeriod": "P0Y2M0DT12H30M5S",
    "status": "PastDue",
    "created": "2020-09-07T19:58:50.550Z",
    "modified": "2020-10-09T14:52:50.550Z",
    "subtotal": 8750,
    "taxAmount": 1225,
    "currencyCode": "USD",
    "invoiceNumber": "BP-27719",
    "amountCredited": 9975,
    "customerName": "Bobs Bait Shop",
    "customerMemo": "It's a pleasure doing business with you.  Remember, referrals are appreciated!",
    "billingEmail": "ben@arima.com",
    "billingAddressType": "HOME",
    "billingAddressLine1": "4567 Finch St.",
    "billingAddressLine2": "Apartment 203",
    "billingCity": "Beverly Hills",
    "billingPostalCode": "90210",
    "shippingAddressType": "BUSINESS",
    "shippingAddressLine1": "350 S Grand Ave",
    "shippingAddressLine2": "Suite 102",
    "shippingCity": "Los Angeles",
    "shippingPostalCode": "90071",
    "srcId": "129",
    "url": "https://bobsburger.com",
    "txnDate": "2020-09-07T19:58:50.550Z",
    "jsonAddress": "{}",
    "subscriptionId": "342",
    "referenceNumber": "B1-7855",
    "accountName": "Bills Bait Shop",
    "billingCountry": "United States",
    "totalAmount": 9975,
    "billingState": "CA",
    "shippingCountry": "United States",
    "shippingState": "CA",
    "amountDue": 6275
  }
]