GET Payments/{id}

Returns all InvoicePayments applied to a single Invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of InvoicePaymentDto
NameDescriptionTypeAdditional information
PaymentID

integer

None.
PaymentHeaderID

integer

None.
InvoiceNumber

integer

None.
InvoiceLineItemID

integer

None.
AppliedFromUnappliedPaymentID

integer

None.
ProfileID

integer

None.
PaymentDate

date

None.
ApplyDate

date

None.
PaymentTypeID

integer

None.
PaymentType

string

None.
Amount

decimal number

None.
Refno

string

None.
CheckNum

string

None.
Notes

string

None.
DateCreated

date

None.
DateChanged

date

None.
ChangedBy

string

None.
Posted

boolean

None.
DatePosted

date

None.
Batch_Creation

string

None.
Batch_Posting

string

None.
PaymentSource

string

None.
CC_CreditCardNum

string

None.
CC_ValidThrough

string

None.
CC_NameOnCard

string

None.
CC_BillingAddress1

string

None.
CC_BillingAddress2

string

None.
CC_BillingCity

string

None.
CC_BillingState

string

None.
CC_BillingZip

string

None.
CC_BillingZipExt

string

None.
CC_PIN

string

None.
CC_PhoneNum

string

None.
PostedBy

string

None.
CreditCardTransaction

CreditCardTransactionDto

None.

Response Formats

application/json, text/json

Sample:
  • [
      {
      • "PaymentID": 1,
      • "PaymentHeaderID": 2,
      • "InvoiceNumber": 3,
      • "InvoiceLineItemID": 4,
      • "AppliedFromUnappliedPaymentID": 5,
      • "ProfileID": 6,
      • "PaymentDate": "2025-01-18T06:59:31.7386571Z",
      • "ApplyDate": "2025-01-18T06:59:31.7386571Z",
      • "PaymentTypeID": 9,
      • "PaymentType": "sample string 10",
      • "Amount": 11.1,
      • "Refno": "sample string 12",
      • "CheckNum": "sample string 13",
      • "Notes": "sample string 14",
      • "DateCreated": "2025-01-18T06:59:31.7386571Z",
      • "DateChanged": "2025-01-18T06:59:31.7386571Z",
      • "ChangedBy": "sample string 17",
      • "Posted": true,
      • "DatePosted": "2025-01-18T06:59:31.7386571Z",
      • "Batch_Creation": "sample string 20",
      • "Batch_Posting": "sample string 21",
      • "PaymentSource": "sample string 22",
      • "CC_CreditCardNum": "sample string 23",
      • "CC_ValidThrough": "sample string 24",
      • "CC_NameOnCard": "sample string 25",
      • "CC_BillingAddress1": "sample string 26",
      • "CC_BillingAddress2": "sample string 27",
      • "CC_BillingCity": "sample string 28",
      • "CC_BillingState": "sample string 29",
      • "CC_BillingZip": "sample string 30",
      • "CC_BillingZipExt": "sample string 31",
      • "CC_PIN": "sample string 32",
      • "CC_PhoneNum": "sample string 33",
      • "PostedBy": "sample string 34",
      • "CreditCardTransaction": {
        • "ID": 1,
        • "TranDate": "2025-01-18T06:59:31.7386571Z",
        • "CardType": "sample string 3",
        • "ProcessMethod": "sample string 4",
        • "Amount": 5.1,
        • "Succeeded": true,
        • "Result": "sample string 7",
        • "CardNumLast4Digits": "sample string 8",
        • "IPAddress": "sample string 9",
        • "ProcessedBy": "sample string 10",
        • "CCGatewayID": 11,
        • "TransactionID": "sample string 12",
        • "AuthorizationCode": "sample string 13",
        • "RefundRequired": true,
        • "RefundReason": "sample string 15",
        • "PaymentTransactionID": "sample string 16",
        • "PurchaseDescr": "sample string 17",
        • "EventSignUpID": 18,
        • "WebInputResponseID": 19,
        • "ManuallyProcessed": true,
        • "RefundAttempts": 21,
        • "ProfileID": 22,
        • "Void": true,
        • "WeblinkTransactionResponse": "sample string 24",
        • "SubscriptionKey": "sample string 25",
        • "CustomerProfileID": "sample string 26",
        • "CustomerPaymentProfileID": "sample string 27",
        • "CcId": "ccid_1",
        • "CreditCardContactInfo": {
          • "Id": 1,
          • "Address1": "sample string 2",
          • "Address2": "sample string 3",
          • "City": "sample string 4",
          • "State": "sample string 5",
          • "Zip": "sample string 6",
          • "ZipExt": "sample string 7",
          • "County": "sample string 8",
          • "Country": "sample string 9",
          • "Phone": "sample string 10",
          • "Ext": "sample string 11",
          • "Email": "sample string 12",
          • "IsCCAddress": true,
          • "NameOnCard": "sample string 14",
          • "FirstName": "sample string 15",
          • "LastName": "sample string 16",
          • "OrgName": "sample string 17",
          • "GatewayProfile": "sample string 18",
          • "CC_TransactionID": 19
          }
        }
      },
      {
      • "PaymentID": 1,
      • "PaymentHeaderID": 2,
      • "InvoiceNumber": 3,
      • "InvoiceLineItemID": 4,
      • "AppliedFromUnappliedPaymentID": 5,
      • "ProfileID": 6,
      • "PaymentDate": "2025-01-18T06:59:31.7386571Z",
      • "ApplyDate": "2025-01-18T06:59:31.7386571Z",
      • "PaymentTypeID": 9,
      • "PaymentType": "sample string 10",
      • "Amount": 11.1,
      • "Refno": "sample string 12",
      • "CheckNum": "sample string 13",
      • "Notes": "sample string 14",
      • "DateCreated": "2025-01-18T06:59:31.7386571Z",
      • "DateChanged": "2025-01-18T06:59:31.7386571Z",
      • "ChangedBy": "sample string 17",
      • "Posted": true,
      • "DatePosted": "2025-01-18T06:59:31.7386571Z",
      • "Batch_Creation": "sample string 20",
      • "Batch_Posting": "sample string 21",
      • "PaymentSource": "sample string 22",
      • "CC_CreditCardNum": "sample string 23",
      • "CC_ValidThrough": "sample string 24",
      • "CC_NameOnCard": "sample string 25",
      • "CC_BillingAddress1": "sample string 26",
      • "CC_BillingAddress2": "sample string 27",
      • "CC_BillingCity": "sample string 28",
      • "CC_BillingState": "sample string 29",
      • "CC_BillingZip": "sample string 30",
      • "CC_BillingZipExt": "sample string 31",
      • "CC_PIN": "sample string 32",
      • "CC_PhoneNum": "sample string 33",
      • "PostedBy": "sample string 34",
      • "CreditCardTransaction": {
        • "ID": 1,
        • "TranDate": "2025-01-18T06:59:31.7386571Z",
        • "CardType": "sample string 3",
        • "ProcessMethod": "sample string 4",
        • "Amount": 5.1,
        • "Succeeded": true,
        • "Result": "sample string 7",
        • "CardNumLast4Digits": "sample string 8",
        • "IPAddress": "sample string 9",
        • "ProcessedBy": "sample string 10",
        • "CCGatewayID": 11,
        • "TransactionID": "sample string 12",
        • "AuthorizationCode": "sample string 13",
        • "RefundRequired": true,
        • "RefundReason": "sample string 15",
        • "PaymentTransactionID": "sample string 16",
        • "PurchaseDescr": "sample string 17",
        • "EventSignUpID": 18,
        • "WebInputResponseID": 19,
        • "ManuallyProcessed": true,
        • "RefundAttempts": 21,
        • "ProfileID": 22,
        • "Void": true,
        • "WeblinkTransactionResponse": "sample string 24",
        • "SubscriptionKey": "sample string 25",
        • "CustomerProfileID": "sample string 26",
        • "CustomerPaymentProfileID": "sample string 27",
        • "CcId": "ccid_1",
        • "CreditCardContactInfo": {
          • "Id": 1,
          • "Address1": "sample string 2",
          • "Address2": "sample string 3",
          • "City": "sample string 4",
          • "State": "sample string 5",
          • "Zip": "sample string 6",
          • "ZipExt": "sample string 7",
          • "County": "sample string 8",
          • "Country": "sample string 9",
          • "Phone": "sample string 10",
          • "Ext": "sample string 11",
          • "Email": "sample string 12",
          • "IsCCAddress": true,
          • "NameOnCard": "sample string 14",
          • "FirstName": "sample string 15",
          • "LastName": "sample string 16",
          • "OrgName": "sample string 17",
          • "GatewayProfile": "sample string 18",
          • "CC_TransactionID": 19
          }
        }
      }
    ]