Invoice Payment

Description

An invoice payment.

Properties

Property Description
amount

The amount of this payment.

amountLessRefunds nullable

The total amount of this payment, minus any refunds applied to it. This is null if the payment is a refund.

billingPostalCode

The billing address postal code. May be null for invoice payments made prior to the introduction of this value.

checkNumber nullable

If this payment was made by check, the check number for the payment.

created read-only

The date on which this payment was logged in the system.

creditCard

When creating a new invoice payment, include the credit card property with this object, if paying by credit card. If you wish to use the invoice credit card that is already on file, set this property to boolean true.

This property is null in responses.

currencyCode read-only

Identifies the currency in which this payment was made. This is always the currency of the invoice; it cannot be set when making a payment.

currencySymbol read-only

The currency symbol for the currency used for this payment.

emailAddress

The email address for the person making the payment.

id

The identifier for this invoice payment.

isPaymentOnHold nullable read-only

If paymentFundsType is "credit-card" and payment was made with ShootProof Payments, this flag indicates whether the funds for this payment are currently on hold. This is typically the case during a five-day period after credit payment was made, but before ShootProof releases the profit to the Studio.

  • If false, the payment has been released.
  • If null, releasing of funds is not applicable such as when made with cash/check, or a non-ShootProof Payments gateway, such as Authorize.Net, Braintree, or PayPal Pro.
  • If either isPaymentOnHold or isPaymentReleased are non-null, only one of them will be true at any point a time.
isPaymentReleased nullable read-only

If paymentFundsType is "credit-card" and payment was made with ShootProof Payments, this flag indicates whether the funds from this payment have been released.

  • If false, the payment is still on hold.
  • If null, releasing of funds is not applicable such as when made with cash/check, or a non-ShootProof Payments gateway, such as Authorize.Net, Braintree, or PayPal Pro.
  • If either isPaymentOnHold or isPaymentReleased are non-null, only one of them will be true at any point a time.
isRefundable read-only

Whether the payment is able to be refunded.

nameOnCard

The card-holder name.

note nullable

A note about the payment.

paymentDate

The date on which this payment was made.

paymentFundsType

The type of funds received for this payment.

paymentReleasedDate nullable read-only

If isPaymentReleased is true, this indicates the date on which the payment was released.

type

The type of object represented.

usedCurrentInvoiceCreditCard read-only

Indicates that payment was made with the current invoice credit card on file.

wasAutomated read-only

Indicates that payment was made via automated payment processor.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "An invoice payment.",
  "properties": {
    "amount": {
      "description": "The amount of this payment.",
      "type": "number"
    },
    "amountLessRefunds": {
      "description": "The total amount of this payment, minus any refunds applied to it.\nThis is `null` if the payment is a refund.",
      "nullable": true,
      "type": "number"
    },
    "billingPostalCode": {
      "description": "The billing address postal code. May be `null` for invoice payments\nmade prior to the introduction of this value.",
      "pattern": "^[A-Za-z0-9 -]{0,10}$",
      "type": "string"
    },
    "checkNumber": {
      "description": "If this payment was made by check, the check number for the payment.",
      "nullable": true,
      "type": "integer"
    },
    "created": {
      "description": "The date on which this payment was logged in the system.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "creditCard": {
      "description": "When creating a new invoice payment, include the credit card\nproperty with this object, if paying by credit card. If you wish to\nuse the invoice credit card that is already on file, set this\nproperty to boolean `true`.\n\nThis property is `null` in responses.",
      "oneOf": [
        {
          "allOf": [
            {
              "nullable": true
            },
            {
              "$ref": "#/components/schemas/InvoiceCreditCard"
            }
          ]
        },
        {
          "description": "`true` to use the invoice credit card on file for this payment.",
          "nullable": true,
          "type": "boolean"
        }
      ]
    },
    "currencyCode": {
      "description": "Identifies the currency in which this payment was made. This is\nalways the currency of the invoice; it cannot be set when making a\npayment.",
      "readOnly": true,
      "type": "string"
    },
    "currencySymbol": {
      "description": "The currency symbol for the currency used for this payment.",
      "readOnly": true,
      "type": "string"
    },
    "emailAddress": {
      "description": "The email address for the person making the payment.",
      "format": "email",
      "type": "string"
    },
    "id": {
      "description": "The identifier for this invoice payment.",
      "type": "integer"
    },
    "isPaymentOnHold": {
      "description": "If `paymentFundsType` is \"credit-card\" and payment was made with\nShootProof Payments, this flag indicates whether the funds for this\npayment are currently on hold. This is typically the case during a\nfive-day period after credit payment was made, but before ShootProof\nreleases the profit to the Studio.\n\n* If `false`, the payment has been released.\n* If `null`, releasing of funds is not applicable such as when made\nwith cash/check, or a non-ShootProof Payments gateway, such as\nAuthorize.Net, Braintree, or PayPal Pro.\n* If either `isPaymentOnHold` or `isPaymentReleased` are non-null,\nonly one of them will be `true` at any point a time.",
      "nullable": true,
      "readOnly": true,
      "type": "boolean"
    },
    "isPaymentReleased": {
      "description": "If `paymentFundsType` is \"credit-card\" and payment was made with\nShootProof Payments, this flag indicates whether the funds from this\npayment have been released.\n\n* If `false`, the payment is still on hold.\n* If `null`, releasing of funds is not applicable such as when made\nwith cash/check, or a non-ShootProof Payments gateway, such as\nAuthorize.Net, Braintree, or PayPal Pro.\n* If either `isPaymentOnHold` or `isPaymentReleased` are non-null,\nonly one of them will be `true` at any point a time.",
      "nullable": true,
      "readOnly": true,
      "type": "boolean"
    },
    "isRefundable": {
      "description": "Whether the payment is able to be refunded.",
      "readOnly": true,
      "type": "boolean"
    },
    "nameOnCard": {
      "description": "The card-holder name.",
      "type": "string"
    },
    "note": {
      "description": "A note about the payment.",
      "nullable": true,
      "type": "string"
    },
    "paymentDate": {
      "description": "The date on which this payment was made.",
      "format": "date-time",
      "type": "string"
    },
    "paymentFundsType": {
      "description": "The type of funds received for this payment.",
      "enum": [
        "cash",
        "check",
        "credit-card"
      ],
      "type": "string"
    },
    "paymentReleasedDate": {
      "description": "If `isPaymentReleased` is `true`, this indicates the date on which\nthe payment was released.",
      "format": "date-time",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "invoice-payment"
      ],
      "type": "string"
    },
    "usedCurrentInvoiceCreditCard": {
      "description": "Indicates that payment was made with the current invoice credit card\non file.",
      "readOnly": true,
      "type": "boolean"
    },
    "wasAutomated": {
      "description": "Indicates that payment was made via automated payment processor.",
      "readOnly": true,
      "type": "boolean"
    }
  },
  "required": [
    "type",
    "amount",
    "paymentFundsType",
    "paymentDate"
  ],
  "title": "Invoice Payment",
  "type": "object"
}