The invoice object

Payment invoice.

Attribute	Type	Description
status	string	Current status of the invoice. Possible values: ["canceled", "created", "disputed", "dispute_lost", "expired", "failed", "marked_as_paid", "paid", "partial_refund", "pending", "refunded", "refund_failed", "refund_pending"]
location.uid	string	Podium unique identifier for location.
location.organizationUid	string	Podium unique identifier for organization.
amount	integer	The amount of the invoice.
uid	string	Podium unique identifier for invoice.
channel.type	string	Messenger channel for the conversation. Possible values: ["apple", "car_wars", "email", "facebook", "fallback_email", "google", "google_brand", "iframe", "instagram", "phone", "secure", "sms", "text", "whatsapp"]
channel.identifier	string	Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS)
requester	string	Name of the employee who initiated the transaction.
createdAt	string	When the invoice was created.
conversationUid	string	Podium unique identifier for conversation.
customerName	string	Name of the customer who received the invoice.
allowedPaymentMethods	array[string]	List all the payment methods available for the invoice.
canceledAt	string	If the invoice has been canceled this will be set to when it was canceled.
canceledNote	string	If the invoice has been canceled this will be an internal note left as to why it was canceled.
currencyRef	string	The currency the invoice was sent in.
invoiceNumber	string	An identifier that can be added manually by a user or as reference ID from an external system.
invoiceServiceChargeItems	array	Separate taxes or service charges applied to an invoice.
invoiceServiceChargeItems[].name	string	Name of the tax or service charge.
invoiceServiceChargeItems[].amount	integer	Amount charged for the tax or service charge, represented in cents.
invoiceServiceChargeItems[].flatChargeAmount	integer	Flat charge amount, represented in cents. Null if PERCENTAGE_BASED
invoiceServiceChargeItems[].percentageChargeRate	string	Tax or service charge percent. Null if FLAT_RATE
invoiceServiceChargeItems[].serviceChargeClassification	string	Classification of tax or service charge. Possible values: ["SERVICE_CHARGE", "SALES_TAX"]
invoiceServiceChargeItems[].serviceChargeType	string	Type of tax or service charge. Possible values: ["FLAT_RATE", "PERCENTAGE_BASED"]
lineItems	array	Separate items or services that make up an invoice.
lineItems[].description	string	Description of the item or service being charged.
lineItems[].amount	integer	Amount to be charged for the line item, represented in cents.
paidAt	string	When the invoice was paid.
paymentNet	integer	The amount of the money from the transaction delivered to the merchant less processing fees, represented in cents.
payments	array	Details of when a customer pays an invoice.
payments[].status	string	Current status of the payment. Possible values: ["disputed", "dispute_lost", "failed", "paid", "partial_refund", "pending", "refunded", "refund_failed", "refund_pending"]
payments[].uid	string	Podium unique identifier for payment.
payments[].createdAt	string	When the payment was made.
payments[].bankAccountLast4	string	Last four digits of the bank account used if bank transfers are used to make a payment.
payments[].bankAccountName	string	Name of the banking institute used if bank transfers are used to make a payment.
payments[].cardBrand	string	Card brand used if a card is used to make a payment.
payments[].cardFunding	string	Card type used if a card is used to make a payment.
payments[].cardLast4	string	Last four digits of the card used if a card is used to make a payment.
payments[].declineCode	string	Code returned by the payment processor if a card was used and the payment was declined.
payments[].declineCodeMessage	string	A more descriptive message about the declideCode attribute.
payments[].fee	integer	Transaction fee removed at the time of the transaction, represented in cents.
payments[].feeBillingType	string	How the transaction fee is billed.
payments[].feeCollectedAt	string	When the transaction fee was collected.
payments[].interchangeFee	integer	Transaction fee that is removed at the beginning of the following month if a merchant is on Interchange+, represented in cents.
payments[].paidWithCardOnFile	boolean	Whether the payment was made with a card on file.
payments[].refunds	array	A refund can be for the full or partial amount of the payment. Thus there can be multiple refunds per transaction.
payments[].refunds[].reason	string	Generic reason for why the refund was intiated. Possible values: ["accidental_charge", "canceled", "duplicate", "fraudulent", "requested_by_customer", "other"]
payments[].refunds[].status	string	Current status of the refund. Possible values: ["failed_charge_for_pending_refund_disputed", "failed_expired_or_cancelled", "failed_lost_or_stolen", "failed_unknown", "succeeded"]
payments[].refunds[].amount	integer	Amount refunded on an invoice, represented in cents.
payments[].refunds[].createdAt	string	When the refund was initiated.
payments[].refunds[].notes	array[string]	Detailed note for why the refund was initiated.
payments[].refunds[].settledAt	string	When the refund was fully completed. Refunds can take 5-10 days to appear in the customer’s bank account.
payments[].settledAt	string	When the money from the transaction was transferred into the merchant’s bank account.
readerUid	string	Podium unique identifier for card reader.
tipAmount	integer	The total tip amount of the invoice.

{
  "status": "canceled",
  "location": {
    "uid": "00000000-0000-0000-0000-000000000000",
    "organizationUid": "00000000-0000-0000-0000-000000000000"
  },
  "amount": 2000,
  "uid": "00000000-0000-0000-0000-000000000000",
  "channel": {
    "type": "email",
    "identifier": "[email protected]"
  },
  "requester": "John Apple",
  "createdAt": "2015-01-23T23:50:07Z",
  "conversationUid": "00000000-0000-0000-0000-000000000000",
  "customerName": "Joe Orange",
  "allowedPaymentMethods": [
    [
      "Bank Account",
      "Buy Now Pay Later Affirm",
      "Credit Card",
      "Debit Dard"
    ]
  ],
  "canceledAt": "2015-01-23T23:50:07Z",
  "canceledNote": "The wrong amount was entered.",
  "currencyRef": "USD",
  "invoiceNumber": "abc-12345-def",
  "invoiceServiceChargeItems": [
    {
      "name": "UT sales tax",
      "amount": 1099,
      "flatChargeAmount": 1099,
      "percentageChargeRate": "3",
      "serviceChargeClassification": "SERVICE_CHARGE",
      "serviceChargeType": "FLAT_RATE"
    }
  ],
  "lineItems": [
    {
      "description": "Total",
      "amount": 1099
    }
  ],
  "paidAt": "2015-01-23T23:50:07Z",
  "paymentNet": 1000,
  "payments": [
    {
      "status": "disputed",
      "uid": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2015-01-23T23:50:07Z",
      "bankAccountLast4": "1245",
      "bankAccountName": "The Bank",
      "cardBrand": "visa",
      "cardFunding": "CREDIT",
      "cardLast4": "4242",
      "declineCode": "card_not_supported",
      "declineCodeMessage": "The card does not support this type of purchase.",
      "fee": 99,
      "feeBillingType": "per_deposit",
      "feeCollectedAt": "2015-01-23T23:50:07Z",
      "interchangeFee": 50,
      "paidWithCardOnFile": true,
      "refunds": [
        {
          "reason": "accidental_charge",
          "status": "failed_charge_for_pending_refund_disputed",
          "amount": 100,
          "createdAt": "2015-01-23T23:50:07Z",
          "notes": [
            "The product did not function properly."
          ],
          "settledAt": "2015-01-23T23:50:07Z"
        }
      ],
      "settledAt": "2015-01-23T23:50:07Z"
    }
  ],
  "readerUid": "00000000-0000-0000-0000-000000000000",
  "tipAmount": 200
}