Retrieve an invoice given an Invoice ID.
Upon success, the operation will return a status code of 200 (OK). If no matching invoice can be associated with the given Invoice ID, a status code of 404 (Not Found) will be returned.
Description of response parameters
- invoiceId
-
The unique identifier of the invoice.
- parentInvoiceId
-
Can be null
The unique identifier of the parent invoice.
- customerId
-
Can be null
The unique identifier of the customer.
- merchantInvoiceRefId
-
Can be null
Merchant's unique identifier for the invoice.
- paymentMethod
-
The payment method information for the payment.
- paymentMethodId
-
The unique identifier of the payment method.
- billingAddressId
-
The unique identifier of the billing address.
- billingFirstName
-
The customers’s first name associated with a payment method that is used for billing purposes.
- billingLastName
-
The customers’s last name associated with a payment method that is used for billing purposes.
- merchantPaymentMethodRefId
-
Can be null
Merchant's unique identifier for the payment method.
- billingAddress
-
The address associated with a payment method that is used for billing purposes.
- addressId
-
The unique identifier of the billing address.
- addressLine1
-
Address.
- addressLine2
-
Can be null
Supplemental information for the address.
- city
-
City.
- state
-
Two-letter state abbreviation.
- postalCode
-
Postal code
- phoneNumber
-
Can be null
The phone number associated with a payment method that is used for billing purposes.
-
Can be null
The email associated with a billing address.
- country
-
The 2-letter country code.
- paymentMethodAchDetails
-
Can be null
The details of ACH payment method.
- accountNumberLast4Digits
-
The last 4 digits of account number.
- accountNumberLength
-
The length of account number.
- accountType
-
The account type. Possible values: Checking, Saving.
- paymentMethodCreditCardDetails
-
Can be null
The details of credit card payment method.
- paymentLast4Digit
-
The last 4 digits of payment account number (PAN).
- paymentExpirationDate
-
The card expiration date.
- entityUseCode
-
Can be null
Avalara tax exemption code associated with an invoice.
- invoiceStatus
-
The status of the invoice. Possible values: Paid, Void, Pending, Recycle, Noncollectable, Failed, Refund, MerchantPaid, MerchantCancelled, OneTimePaymentPending, PartialRefund, BatchPending, CapturePending, RefundPending, RefundDeclined, RefundFailed.
- subtotal
-
The subtotal invoice amount.
- tax
-
The tax amount.
- total
-
The total invoice amount.
- billingDate
-
The day on which the last billing was attempted for the invoice.
- taxFinalizationStatus
-
Tax finalization status on the transaction. Possible values: Pending, Collected, MerchantCollected, Uncollectable, NotCollected, TaxNotEnabled.
- merchantLegalName
-
Can be null
Merchant’s legal name.
- merchantCustomerRefId
-
Can be null
Merchant's unique identifier for the customer.
- customerEntityUseCode
-
Can be null
Avalara tax exemption code associated with a customer.
- customerFirstName
-
Customer's first name.
- customerLastName
-
Customer's last name.
- subscriptionId
-
Can be null
The unique identifier of the subscription.
- installmentId
-
Can be null
The unique identifier of the installment.
- eligibilityFailReason
-
Can be null
If the eligibility check is enabled, there could be the fail reason.
- merchantSubscriptionRefId
-
Can be null
Merchant's unique identifier for the subscription.
- invoiceLineItemId
-
The unique identifier of the invoice line item.
- name
-
Name of the invoice line item.
- description
-
Description of the invoice line item.
- value
-
The amount information for the payment (USD). The tax amount is excluded if tax code is supplied.
- valueType
-
A qualifier for how the value should be interpreted. Possible values: Standard, Discount, DiscountPercentage, FinalDiscount, PriceOverride.
- taxCode
-
Can be null
Avalara tax code.
- invoiceAttempts
-
Can be null
- invoiceAttemptId
-
The unique identifier of the invoice attempt.
- amount
-
The total invoice amount.
- invoiceAttemptStatus
-
The status of the invoice attempt. Possible values: Success, Fail, Pending.
- invoiceAttemptDate
-
The date and time of attempt.
- paymentProcessor
-
The name of the processor by which the transaction was processed.
- processorTransactionId
-
The unique identifier of the transaction.
- responseCode
-
The processor response code.
- responseMessage
-
The processor response message.
- eligibilityCheckOrderCode
-
Can be null
The order code received during during eligibility check.