Invoice Info (GET)

      Invoice Info (GET)


        Article summary

        GET
        Live: https://checkout.buckaroo.nl/json/Transaction/InvoiceInfo/{invoiceKey}
        Test: https://testcheckout.buckaroo.nl/json/Transaction/InvoiceInfo/{invoiceKey}

        This returns the invoice info for Credit Management (old) invoices.

        The authentication of this JSON API is based on a standard HMAC Authentication implementation.

        Request information

        URI Parameters

        NameTypeDescription
        invoiceKeystring

        Response information

        InvoiceInfoResponseInvoice

        NameTypeDescription
        Keystring None.
        Numberstring
        CustomerIDstring
        CreditManagementboolean
        Testboolean
        StatusCreditManagementStatus
        Paidboolean
        Paylinkstring
        Currencystring
        AmountDebitdecimal number
        AmountCreditdecimal number
        AmountVatdecimal number
        AmountCreditVatdecimal number
        AmountPaiddecimal number
        SurchargeAmountdecimal number
        MaxReminderLevelinteger
        InvoiceDatedate
        DueDatedate
        CreatedDatetimedate
        StatusDatetimedate
        EstimatedNextStepDatedate
        CreditNotesCollection of CreditNote
        TransactionsCollection of Transaction
        Orderstring

        Request formats

        {
          "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": "2022-08-22T14:33:56.26112+02:00",
                "Type": "sample string 2",
                "Status": "sample string 3"
              },
              {
                "Date": "2022-08-22T14:33:56.26112+02: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": "2022-08-22T14:33:56.26112+02:00",
          "DueDate": "2022-08-22T14:33:56.26112+02:00",
          "CreatedDatetime": "2022-08-22T14:33:56.26112+02:00",
          "StatusDatetime": "2022-08-22T14:33:56.26112+02:00",
          "EstimatedNextStepDate": "2022-08-22T14:33:56.26112+02: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": "2022-08-22T14:33:56.26112+02:00",
              "Status": {
                "Success": true,
                "Code": "sample string 2",
                "Message": "sample string 3",
                "Datetime": "2022-08-22T14:33:56.26112+02:00"
              },
              "Refunds": [
                {
                  "ID": "sample string 1",
                  "Amount": 2.0,
                  "RefundDate": "2022-08-22T14:33:56.26112+02:00",
                  "Status": {
                    "Success": true,
                    "Code": "sample string 2",
                    "Message": "sample string 3",
                    "Datetime": "2022-08-22T14:33:56.26112+02:00"
                  }
                },
                {
                  "ID": "sample string 1",
                  "Amount": 2.0,
                  "RefundDate": "2022-08-22T14:33:56.26112+02:00",
                  "Status": {
                    "Success": true,
                    "Code": "sample string 2",
                    "Message": "sample string 3",
                    "Datetime": "2022-08-22T14:33:56.26112+02: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": "2022-08-22T14:33:56.26112+02:00",
              "Status": {
                "Success": true,
                "Code": "sample string 2",
                "Message": "sample string 3",
                "Datetime": "2022-08-22T14:33:56.26112+02:00"
              },
              "Refunds": [
                {
                  "ID": "sample string 1",
                  "Amount": 2.0,
                  "RefundDate": "2022-08-22T14:33:56.26112+02:00",
                  "Status": {
                    "Success": true,
                    "Code": "sample string 2",
                    "Message": "sample string 3",
                    "Datetime": "2022-08-22T14:33:56.26112+02:00"
                  }
                },
                {
                  "ID": "sample string 1",
                  "Amount": 2.0,
                  "RefundDate": "2022-08-22T14:33:56.26112+02:00",
                  "Status": {
                    "Success": true,
                    "Code": "sample string 2",
                    "Message": "sample string 3",
                    "Datetime": "2022-08-22T14:33:56.26112+02:00"
                  }
                }
              ]
            }
          ],
          "Order": "sample string 8"
        }
        

        Was this article helpful?