POST json/Transaction/InvoiceInfos
This returns the invoice info(s)
Request Information
URI Parameters
None.
Body Parameters
InvoiceInfoRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceCollection | Collection of InvoiceInfoRequestInvoice |
None. |
Request Formats
application/json, text/json
Sample:
{
"InvoiceCollection": [
{
"Key": "sample string 1",
"Number": "sample string 2",
"CustomerID": "sample string 3"
},
{
"Key": "sample string 1",
"Number": "sample string 2",
"CustomerID": "sample string 3"
}
]
}
text/html
Sample:
{"InvoiceCollection":[{"Key":"sample string 1","Number":"sample string 2","CustomerID":"sample string 3"},{"Key":"sample string 1","Number":"sample string 2","CustomerID":"sample string 3"}]}
Response Information
Resource Description
InvoiceInfoResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceCollection | Collection of InvoiceInfoResponseInvoice |
None. |
|
| InvalidInvoiceCollection | Collection of InvalidInvoice |
None. |
Response Formats
application/json, text/json
Sample:
{
"InvoiceCollection": [
{
"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-12-03T18:10:56.7888233+01:00",
"Type": "sample string 2",
"Status": "sample string 3"
},
{
"Date": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"DueDate": "2024-12-03T18:10:56.7888233+01:00",
"CreatedDatetime": "2024-12-03T18:10:56.7888233+01:00",
"StatusDatetime": "2024-12-03T18:10:56.7888233+01:00",
"EstimatedNextStepDate": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
},
"Refunds": [
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
},
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
},
"Refunds": [
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
},
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
}
]
}
],
"Order": "sample string 8"
},
{
"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-12-03T18:10:56.7888233+01:00",
"Type": "sample string 2",
"Status": "sample string 3"
},
{
"Date": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"DueDate": "2024-12-03T18:10:56.7888233+01:00",
"CreatedDatetime": "2024-12-03T18:10:56.7888233+01:00",
"StatusDatetime": "2024-12-03T18:10:56.7888233+01:00",
"EstimatedNextStepDate": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
},
"Refunds": [
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
},
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
},
"Refunds": [
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
},
{
"ID": "sample string 1",
"Amount": 2.0,
"RefundDate": "2024-12-03T18:10:56.7888233+01:00",
"Status": {
"Success": true,
"Code": "sample string 2",
"Message": "sample string 3",
"Datetime": "2024-12-03T18:10:56.7888233+01:00"
}
}
]
}
],
"Order": "sample string 8"
}
],
"InvalidInvoiceCollection": [
{
"ErrorMessage": "sample string 1",
"Key": "sample string 1",
"Number": "sample string 2",
"CustomerID": "sample string 3"
},
{
"ErrorMessage": "sample string 1",
"Key": "sample string 1",
"Number": "sample string 2",
"CustomerID": "sample string 3"
}
]
}
text/html
Sample:
{"InvoiceCollection":[{"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-12-03T18:10:56.7888233+01:00","Type":"sample string 2","Status":"sample string 3"},{"Date":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","DueDate":"2024-12-03T18:10:56.7888233+01:00","CreatedDatetime":"2024-12-03T18:10:56.7888233+01:00","StatusDatetime":"2024-12-03T18:10:56.7888233+01:00","EstimatedNextStepDate":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}}]}],"Order":"sample string 8"},{"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-12-03T18:10:56.7888233+01:00","Type":"sample string 2","Status":"sample string 3"},{"Date":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","DueDate":"2024-12-03T18:10:56.7888233+01:00","CreatedDatetime":"2024-12-03T18:10:56.7888233+01:00","StatusDatetime":"2024-12-03T18:10:56.7888233+01:00","EstimatedNextStepDate":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+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-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"},"Refunds":[{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}},{"ID":"sample string 1","Amount":2.0,"RefundDate":"2024-12-03T18:10:56.7888233+01:00","Status":{"Success":true,"Code":"sample string 2","Message":"sample string 3","Datetime":"2024-12-03T18:10:56.7888233+01:00"}}]}],"Order":"sample string 8"}],"InvalidInvoiceCollection":[{"ErrorMessage":"sample string 1","Key":"sample string 1","Number":"sample string 2","CustomerID":"sample string 3"},{"ErrorMessage":"sample string 1","Key":"sample string 1","Number":"sample string 2","CustomerID":"sample string 3"}]}