GET json/Transaction/InvoiceInfo/{invoiceKey}

This returns the refund info

Request Information

URI Parameters

NameDescriptionTypeAdditional information
invoiceKey

string

Required

Body Parameters

None.

Response Information

Resource Description

InvoiceInfoResponseInvoice
NameDescriptionTypeAdditional information
Key

string

None.

Number

string

None.

CustomerID

string

None.

CreditManagement

boolean

None.

Test

boolean

None.

Status

CreditManagementStatus

None.

Paid

boolean

None.

Paylink

string

None.

Currency

string

None.

AmountDebit

decimal number

None.

AmountCredit

decimal number

None.

AmountVat

decimal number

None.

AmountCreditVat

decimal number

None.

AmountPaid

decimal number

None.

SurchargeAmount

decimal number

None.

MaxReminderLevel

integer

None.

InvoiceDate

date

None.

DueDate

date

None.

CreatedDatetime

date

None.

StatusDatetime

date

None.

EstimatedNextStepDate

date

None.

CreditNotes

Collection of CreditNote

None.

Transactions

Collection of Transaction

None.

Order

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Key": "sample string 1",
  "Number": "sample string 2",
  "CustomerID": "sample string 3",
  "CreditManagement": true,
  "Test": true,
  "Status": {
    "CMStatus": 1,
    "Running": true,
    "RemindersSent": 3,
    "AgencyStatusAsString": "unsent",
    "AgencyUpdates": [
      {
        "Date": "2024-03-29T07:05:56.0095761+01:00",
        "Type": "sample string 2",
        "Status": "sample string 3"
      },
      {
        "Date": "2024-03-29T07:05:56.0095761+01:00",
        "Type": "sample string 2",
        "Status": "sample string 3"
      }
    ]
  },
  "Paid": true,
  "Paylink": "sample string 6",
  "Currency": "sample string 7",
  "AmountDebit": 1.0,
  "AmountCredit": 1.0,
  "AmountVat": 1.0,
  "AmountCreditVat": 1.0,
  "AmountPaid": 1.0,
  "SurchargeAmount": 1.0,
  "MaxReminderLevel": 1,
  "InvoiceDate": "2024-03-29T07:05:56.0095761+01:00",
  "DueDate": "2024-03-29T07:05:56.0095761+01:00",
  "CreatedDatetime": "2024-03-29T07:05:56.0095761+01:00",
  "StatusDatetime": "2024-03-29T07:05:56.0095761+01:00",
  "EstimatedNextStepDate": "2024-03-29T07:05:56.0095761+01:00",
  "CreditNotes": [
    {
      "Number": "sample string 1",
      "Amount": 2.0,
      "AmountVat": 3.0,
      "Description": "sample string 4"
    },
    {
      "Number": "sample string 1",
      "Amount": 2.0,
      "AmountVat": 3.0,
      "Description": "sample string 4"
    }
  ],
  "Transactions": [
    {
      "ID": "sample string 1",
      "Type": "sample string 2",
      "TypeDescription": "sample string 3",
      "Test": true,
      "Currency": "sample string 5",
      "AmountDebit": 1.0,
      "AmountCredit": 1.0,
      "AmountRefundable": 6.0,
      "Description": "sample string 7",
      "CreatedDatetime": "2024-03-29T07:05:56.0095761+01:00",
      "Status": {
        "Success": true,
        "Code": "sample string 2",
        "Message": "sample string 3",
        "Datetime": "2024-03-29T07:05:56.0095761+01:00"
      },
      "Refunds": [
        {
          "ID": "sample string 1",
          "Amount": 2.0,
          "RefundDate": "2024-03-29T07:05:56.0095761+01:00",
          "Status": {
            "Success": true,
            "Code": "sample string 2",
            "Message": "sample string 3",
            "Datetime": "2024-03-29T07:05:56.0095761+01:00"
          }
        },
        {
          "ID": "sample string 1",
          "Amount": 2.0,
          "RefundDate": "2024-03-29T07:05:56.0095761+01:00",
          "Status": {
            "Success": true,
            "Code": "sample string 2",
            "Message": "sample string 3",
            "Datetime": "2024-03-29T07:05:56.0095761+01:00"
          }
        }
      ]
    },
    {
      "ID": "sample string 1",
      "Type": "sample string 2",
      "TypeDescription": "sample string 3",
      "Test": true,
      "Currency": "sample string 5",
      "AmountDebit": 1.0,
      "AmountCredit": 1.0,
      "AmountRefundable": 6.0,
      "Description": "sample string 7",
      "CreatedDatetime": "2024-03-29T07:05:56.0095761+01:00",
      "Status": {
        "Success": true,
        "Code": "sample string 2",
        "Message": "sample string 3",
        "Datetime": "2024-03-29T07:05:56.0095761+01:00"
      },
      "Refunds": [
        {
          "ID": "sample string 1",
          "Amount": 2.0,
          "RefundDate": "2024-03-29T07:05:56.0095761+01:00",
          "Status": {
            "Success": true,
            "Code": "sample string 2",
            "Message": "sample string 3",
            "Datetime": "2024-03-29T07:05:56.0095761+01:00"
          }
        },
        {
          "ID": "sample string 1",
          "Amount": 2.0,
          "RefundDate": "2024-03-29T07:05:56.0095761+01:00",
          "Status": {
            "Success": true,
            "Code": "sample string 2",
            "Message": "sample string 3",
            "Datetime": "2024-03-29T07:05:56.0095761+01:00"
          }
        }
      ]
    }
  ],
  "Order": "sample string 8"
}

text/html

Sample:
{"Key":"sample string 1","Number":"sample string 2","CustomerID":"sample string 3","CreditManagement":true,"Test":true,"Status":{"CMStatus":1,"Running":true,"RemindersSent":3,"AgencyStatusAsString":"unsent","AgencyUpdates":[{"Date":"2024-03-29T07:05:56.0095761+01:00","Type":"sample string 2","Status":"sample string 3"},{"Date":"2024-03-29T07:05:56.0095761+01:00","Type":"sample string 2","Status":"sample string 3"}]},"Paid":true,"Paylink":"sample string 6","Currency":"sample string 7","AmountDebit":1.0,"AmountCredit":1.0,"AmountVat":1.0,"AmountCreditVat":1.0,"AmountPaid":1.0,"SurchargeAmount":1.0,"MaxReminderLevel":1,"InvoiceDate":"2024-03-29T07:05:56.0095761+01:00","DueDate":"2024-03-29T07:05:56.0095761+01:00","CreatedDatetime":"2024-03-29T07:05:56.0095761+01:00","StatusDatetime":"2024-03-29T07:05:56.0095761+01:00","EstimatedNextStepDate":"2024-03-29T07:05:56.0095761+01:00","CreditNotes":[{"Number":"sample string 1","Amount":2.0,"AmountVat":3.0,"Description":"sample string 4"},{"Number":"sample string 1","Amount":2.0,"AmountVat":3.0,"Description":"sample string 4"}],"Transactions":[{"ID":"sample string 1","Type":"sample string 2","TypeDescription":"sample string 3","Test":true,"Currency":"sample string 5","AmountDebit":1.0,"AmountCredit":1.0,"AmountRefundable":6.0,"Description":"sample string 7","CreatedDatetime":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"}}]},{"ID":"sample string 1","Type":"sample string 2","TypeDescription":"sample string 3","Test":true,"Currency":"sample string 5","AmountDebit":1.0,"AmountCredit":1.0,"AmountRefundable":6.0,"Description":"sample string 7","CreatedDatetime":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-03-29T07:05:56.0095761+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-03-29T07:05:56.0095761+01:00"}}]}],"Order":"sample string 8"}