GET B2BInvoice

Returns the first downloadable Invoices for a given Supplier

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userName

Username for Account to be used for Authentication/Authorization

string

Required

password

Password for Account to be used for Authentication/Authorization

string

Required

internalUser

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

An invoice record with an HTTP 200, or null with the relevant HTTP error code.

Collection of InvoiceHeaderViewModel
NameDescriptionTypeAdditional information
HeaderVersion

string

String length: inclusive between 0 and 50

SenderEAN

string

String length: inclusive between 0 and 15

ReceiverEAN

string

String length: inclusive between 0 and 15

InvoiceRefNo

globally unique identifier

None.

Standard

string

String length: inclusive between 0 and 50

TypeVersion

string

String length: inclusive between 0 and 50

InstanceIdentifier

string

String length: inclusive between 0 and 50

InvoiceType

string

String length: inclusive between 0 and 50

MultipleType

string

String length: inclusive between 0 and 50

DocumentCreationDatetime

date

None.

MessageId

string

String length: inclusive between 0 and 50

ContentOwnerGLN

string

String length: inclusive between 0 and 20

CommandType

string

String length: inclusive between 0 and 50

CommandOwnerGLN

string

String length: inclusive between 0 and 20

DocumentStatus

string

String length: inclusive between 0 and 50

ContentVersion

string

String length: inclusive between 0 and 10

DocumentVersion

string

String length: inclusive between 0 and 10

DocumentNumber

string

String length: inclusive between 0 and 50

CurrencyISOCode

string

String length: inclusive between 0 and 10

Type

string

String length: inclusive between 0 and 50

CountryISOCode

string

String length: inclusive between 0 and 10

BuyerGLN

string

String length: inclusive between 0 and 20

SellerGLN

string

String length: inclusive between 0 and 20

ShipToGLN

string

String length: inclusive between 0 and 20

VATRegistrationNumber

string

String length: inclusive between 0 and 20

DocumentTotalExVAT

decimal number

None.

DocumentTotalInclVAT

decimal number

None.

DocumentTotalVAT

decimal number

None.

OrderNumber

integer

None.

PurchaseOrder

string

String length: inclusive between 0 and 25

InvoiceDate

date

None.

InvoiceNumber

string

String length: inclusive between 0 and 20

InvoiceDetails

Collection of InvoiceDetailLineViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "HeaderVersion": "sample string 1",
    "SenderEAN": "sample string 2",
    "ReceiverEAN": "sample string 3",
    "InvoiceRefNo": "a393207d-e46c-40da-8fb9-786b161e06f9",
    "Standard": "sample string 5",
    "TypeVersion": "sample string 6",
    "InstanceIdentifier": "sample string 7",
    "InvoiceType": "sample string 8",
    "MultipleType": "sample string 9",
    "DocumentCreationDatetime": "2024-04-29T18:37:00.3517929+02:00",
    "MessageId": "sample string 11",
    "ContentOwnerGLN": "sample string 12",
    "CommandType": "sample string 13",
    "CommandOwnerGLN": "sample string 14",
    "DocumentStatus": "sample string 15",
    "ContentVersion": "sample string 16",
    "DocumentVersion": "sample string 17",
    "DocumentNumber": "sample string 18",
    "CurrencyISOCode": "sample string 19",
    "Type": "sample string 20",
    "CountryISOCode": "sample string 21",
    "BuyerGLN": "sample string 22",
    "SellerGLN": "sample string 23",
    "ShipToGLN": "sample string 24",
    "VATRegistrationNumber": "sample string 25",
    "DocumentTotalExVAT": 26.0,
    "DocumentTotalInclVAT": 27.0,
    "DocumentTotalVAT": 28.0,
    "OrderNumber": 29,
    "PurchaseOrder": "sample string 30",
    "InvoiceDate": "2024-04-29T18:37:00.3517929+02:00",
    "InvoiceNumber": "sample string 32",
    "InvoiceDetails": [
      {
        "InvoiceDetailRefNo": "c5b81299-72d7-4fe2-a294-e61fb7c57beb",
        "InvoiceRefNo": "b23b72e2-172f-4ef7-ac3a-bbca08ebc647",
        "LineNumber": 3,
        "EANNumber": "sample string 4",
        "SupplierCode": 5,
        "Quantity": 1.1,
        "PackSize": 6.1,
        "TaxPercentage": 7.1,
        "TaxFeeCategory": "sample string 8",
        "UnitOfMeasure": "sample string 9",
        "TransferOfOwnershipDate": "sample string 10",
        "CostPrice": 1.0,
        "LanguageISOCode": "sample string 11",
        "Description": "sample string 12",
        "NettPrice": 13.0,
        "TaxFeeType": "sample string 14",
        "TaxAmount": 15.0
      },
      {
        "InvoiceDetailRefNo": "c5b81299-72d7-4fe2-a294-e61fb7c57beb",
        "InvoiceRefNo": "b23b72e2-172f-4ef7-ac3a-bbca08ebc647",
        "LineNumber": 3,
        "EANNumber": "sample string 4",
        "SupplierCode": 5,
        "Quantity": 1.1,
        "PackSize": 6.1,
        "TaxPercentage": 7.1,
        "TaxFeeCategory": "sample string 8",
        "UnitOfMeasure": "sample string 9",
        "TransferOfOwnershipDate": "sample string 10",
        "CostPrice": 1.0,
        "LanguageISOCode": "sample string 11",
        "Description": "sample string 12",
        "NettPrice": 13.0,
        "TaxFeeType": "sample string 14",
        "TaxAmount": 15.0
      }
    ]
  },
  {
    "HeaderVersion": "sample string 1",
    "SenderEAN": "sample string 2",
    "ReceiverEAN": "sample string 3",
    "InvoiceRefNo": "a393207d-e46c-40da-8fb9-786b161e06f9",
    "Standard": "sample string 5",
    "TypeVersion": "sample string 6",
    "InstanceIdentifier": "sample string 7",
    "InvoiceType": "sample string 8",
    "MultipleType": "sample string 9",
    "DocumentCreationDatetime": "2024-04-29T18:37:00.3517929+02:00",
    "MessageId": "sample string 11",
    "ContentOwnerGLN": "sample string 12",
    "CommandType": "sample string 13",
    "CommandOwnerGLN": "sample string 14",
    "DocumentStatus": "sample string 15",
    "ContentVersion": "sample string 16",
    "DocumentVersion": "sample string 17",
    "DocumentNumber": "sample string 18",
    "CurrencyISOCode": "sample string 19",
    "Type": "sample string 20",
    "CountryISOCode": "sample string 21",
    "BuyerGLN": "sample string 22",
    "SellerGLN": "sample string 23",
    "ShipToGLN": "sample string 24",
    "VATRegistrationNumber": "sample string 25",
    "DocumentTotalExVAT": 26.0,
    "DocumentTotalInclVAT": 27.0,
    "DocumentTotalVAT": 28.0,
    "OrderNumber": 29,
    "PurchaseOrder": "sample string 30",
    "InvoiceDate": "2024-04-29T18:37:00.3517929+02:00",
    "InvoiceNumber": "sample string 32",
    "InvoiceDetails": [
      {
        "InvoiceDetailRefNo": "c5b81299-72d7-4fe2-a294-e61fb7c57beb",
        "InvoiceRefNo": "b23b72e2-172f-4ef7-ac3a-bbca08ebc647",
        "LineNumber": 3,
        "EANNumber": "sample string 4",
        "SupplierCode": 5,
        "Quantity": 1.1,
        "PackSize": 6.1,
        "TaxPercentage": 7.1,
        "TaxFeeCategory": "sample string 8",
        "UnitOfMeasure": "sample string 9",
        "TransferOfOwnershipDate": "sample string 10",
        "CostPrice": 1.0,
        "LanguageISOCode": "sample string 11",
        "Description": "sample string 12",
        "NettPrice": 13.0,
        "TaxFeeType": "sample string 14",
        "TaxAmount": 15.0
      },
      {
        "InvoiceDetailRefNo": "c5b81299-72d7-4fe2-a294-e61fb7c57beb",
        "InvoiceRefNo": "b23b72e2-172f-4ef7-ac3a-bbca08ebc647",
        "LineNumber": 3,
        "EANNumber": "sample string 4",
        "SupplierCode": 5,
        "Quantity": 1.1,
        "PackSize": 6.1,
        "TaxPercentage": 7.1,
        "TaxFeeCategory": "sample string 8",
        "UnitOfMeasure": "sample string 9",
        "TransferOfOwnershipDate": "sample string 10",
        "CostPrice": 1.0,
        "LanguageISOCode": "sample string 11",
        "Description": "sample string 12",
        "NettPrice": 13.0,
        "TaxFeeType": "sample string 14",
        "TaxAmount": 15.0
      }
    ]
  }
]