Get Information About 1 Invoice/CreditNote

Get 1 Invoice

Instruction:

Endpoint	Method	Response	Extra Info
/v1/orders/OrderID	GET	1 document	Includes full data and file references

When the Get of one specific Billit Order ID is launched, the full data is returned.

Main elements of the data

Because of the response containing allot of information you will have a brief summary below of the most important fields.

Property	Value Type	Info
OrderID	UniqueID	Same ID as in request. The Billit ID.
CompanyID	UniqueID	Company Ownner ID of the invoice in Billit system
OrderPDF	Object	Contains the PDF generated by Billit (if not sent by supplier) or provided for the invoice (if included by the supplier)
Attachments	List	Contains the optional additional Attachments.
OrderNumber	ID	Document number reference by supplier of the Invoice or Creditnote
Customer	Object	Contains metadata for the invoice customer
Supplier	Object	Contains metadata for the Supplier
LastModified	DateTime	Last datetime when the invoice was modified
Created	Datetime	The date when the api processed the invoice
Orderlines	List	Contains the Invoice items in a list with tax calculated on them
VatGroups	List	Contains the different vatgroups calculated for the Invoice
Paid	Bool	When indicated by supplier as already paid

Example output below. The Comments have been added to make it more practical for understanding how to process it.

{
    "OrderID": 1194146,
    "CompanyID": 588708,
    "OrderPDF": {  //Main PDF 
        "FileID": "2b5d8f7b-dd7a-4ece-adb3-d3ec7d8ff781",
        "FileName": "162121-186660-46bfc55d-be37-4d77-b5fc-578a782c6f59.xml_1.pdf"
    },
    "Attachments": [ //1 or more attachments (Excel, PDF, XML, ...)
        {
            "FileID": "b049d8eb-9330-4097-be9e-c8a564f5cee6",
            "FileName": "162121-186660-46bfc55d-be37-4d77-b5fc-578a782c6f59.xml"
        }
    ],
    "OrderNumber": "QS-244SC", //number by supplier of the Invoice or Creditnote
    "Customer": {  //Customer is Receiver of the document
        "PartyID": 588708,  //Technical ID Billit
        "Name": "Test Supplier",  //Name Customer 
        "Addresses": [
            {
                "AddressType": "InvoiceAddress",  
                "Street": "Teststraat",  //Info in customer segment about the customer
                "StreetNumber": "1",
                "Box": "2",
                "Zipcode": "9000",
                "City": "Gent",
                "CountryCode": "BE"
            },
            {
                "AddressType": "DeliveryAddress", //If delivery information is provided by the supplier, then info is in this segment
                "CountryCode": "BE"
            }
        ],
        "Street": "Teststraat",
        "StreetNumber": "1",
        "Box": "2",
        "Zipcode": "9000",
        "City": "Gent",
        "CountryCode": "BE",
        "IBAN": "BE26310086399929",  //Bank account of customer
        "BIC": "BBRUBEBB",  //BIC of the bank account
        "Mobile": "+32479991999",  //Mobile number of customer contact
        "Phone": "+3224600999", //Phone number of customer contact
        "Email": "[email protected]", //Email of customer contact
        "Contact": "John Doe1", //Name of customer contact
        "ContactFirstName": "John",
        "ContactLastName": "Doe1",
        "VATNumber": "BE0446725877",  //VAT of customer 
        "LastModified": "2025-04-25T09:21:48.993", //When was Customer info updated in billit DB 
        "Created": "2025-04-01T09:34:20.563",
        "PartyType": "Customer",
        "VATLiable": true,  //Below possible information in Billit customerDB
        "Language": "EN",  
        "VentilationCode": "4",
        "CustomFields": [],
        "BankAccounts": [],
        "Users": [],
        "DefaultPaid": false,
        "DisplayName": "Sercu Microdata nv",
        "FinancialReductionDaysDefault": 8,
        "DefaultExpiryOffset": 30,
        "GLDefaultExpiryOffset": 30,
        "VATDeductable": true,
        "DefaultReductionPercentage": 0.00,
        "Identifiers": [],
        "SmallEnterprise": false,
        "DefaultCurrencyTC": "EUR",
        "SendUBL": true,
        "SendPDF": true
    },
    "Supplier": {  //Information about the Supplier / Sender of the document
        "PartyID": 602403,
        "Nr": "",
        "Name": "TestCustomer",
        "Addresses": [
            {
                "AddressType": "InvoiceAddress", //Info in customer segment about the customer in the XML
                "Street": "Tehc Street 1 Floor 1",
                "Zipcode": "1000",
                "City": "Tech City",
                "CountryCode": "BE"
            },
            {
                "AddressType": "DeliveryAddress",  //If delivery information is provided by the supplier, then info is in this segment
                "Street": "Tehc Street 1 Floor 1",
                "Zipcode": "1000",
                "City": "Tech City",
                "CountryCode": "BE"
            }
        ],
        "Street": "Tehc Street 1 Floor 1", //Main Address of Supplier is repeated in this part
        "Zipcode": "1000",
        "CostCategoryCode": 610220,
        "City": "Tech City",
        "CountryCode": "BE",
        "IBAN": "BE2631008777777"  //Bank account of supplier, account to pay on  
        "BIC": "BBRUBEBB",   //BIC of the bank account
        "Email": "[email protected]", //Email of supplier contact
        "Contact": "",  //Name of supplier contact
        "ContactLastName": "", //LastName of supplier contact
        "VATNumber": "BE0454299999", //VAT number of supplier 
        "LastModified": "2025-04-25T16:22:24.677",  //When was supplier contact info modified last time in Billit DB 
        "Created": "2025-04-22T08:17:35.827",
        "PartyType": "Supplier",
        "VATLiable": true,
        "Language": "NL",
        "VentilationCode": "1",
        "CustomFields": [],
        "BankAccounts": [],
        "Users": [],
        "DefaultPaid": false,
        "DisplayName": "TestSupplier",
        "DefaultExpiryOffset": 30,
        "GLDefaultExpiryOffset": 30,
        "VATDeductable": true,
        "DefaultReductionPercentage": 0.00,
        "Identifiers": [
            {
                "IdentifierType": "CBE",  //Additional Identifier, CBE is company number, GLN refers to GLN Number.  multiple occurencies are possible.  List of identifiers https://docs.billit.be/docs/allowed-identifiers
                "Identifier": "0454299999",
                "SchemeID": "0208",
                "Preferred": false
            }
        ],
        "SmallEnterprise": false,
        "SendUBL": true,
        "SendPDF": true
    },
    "CounterParty": { //For receiving this is same information as in supplier segment, so no need to used it
    //................
    },
    "OrderDate": "2025-04-25T00:00:00",  //Date of the Invoice
    "ExpiryDate": "2025-05-30T00:00:00",  //DueDate 
    "OrderType": "Invoice",   // Type : Invoice or Creditnote
    "LastModified": "2025-04-25T16:22:25.457",  // Type : Modification can include a statusupdate
    "Created": "2025-04-25T16:22:24.643",  // Creation date/time at Billit when receiving
    "OrderDirection": "Cost",  // This is supplier invoice for Accounts Payable / Expense / Cost
    "OrderLines": [  //Start of the lines
        {
            "Quantity": 2.00000,  //Number of pieces  Peppol InvoiceLine/InvoicedQuantity
            "UnitPriceExcl": 12.00000,  //Unit Price excluding VAT
            "Reference": "915025",  //Supplier Article Number.  Peppol InvoiceLine/Item/SellersItemIdentification
            "Description": "my descr line1",  //Name  (Peppol InvoiceLine/Item/Name)
            "TotalExcl": 24.00,  //Total Price excluding VAT
            "TotalVAT": 5.04,  //Total VAT amount of line (Calculated by Billit, not on the UBL file)
            "VATPercentage": 21.00,  // VAT % of the line
            "VentilationCode": "1",  //Info about ventillation code https://docs.billit.be/docs/ventilation-codes
            "CustomFields": { 
                "Name": "my descr line1",  //Name  (Peppol InvoiceLine/Item/Name)
                "PeppolLineID": "1"  //InvoiceLineNumber mentioned by the Supplier (Peppol InvoiceLine/ID)
            },
            "InclLeading": false,
            "TotalIncl": 29.04,  //Total amount of the line, incl. VAT  (calculated by Billit, non the the Peppol XML)
            "DescriptionExtended": "Box of cookies 20 pieces, 200 g"  //Longer description (Peppol InvoiceLine/Item/Description)
        },
        {
            "Quantity": 3.00000,
            "UnitPriceExcl": 5.00000,
            "Description": "Services",
            "TotalExcl": 15.00,
            "TotalVAT": 0.00,
            "VATPercentage": 0.00,
            "VentilationCode": "1",
            "CustomFields": {
                "Name": "Services",
                "PeppolLineID": "2"
            },
            "InclLeading": false,
            "TotalIncl": 15.00
        }
    ],
    "OrderTitle": "header note description",  //Additional text info on header (Peppol : Note)
    "PaymentDiscountPercentage": 0.00,  
    "PaymentDiscountAmount": 0.00,
    "VatGroups": [   //VAT Subtotals
        {     //VAT Subtotal 1
            "VentilationCode": "1",
            "VATPercentage": 0.00,
            "TotalExcl": 15.00,
            "TotalVAT": 0.00,
            "TotalIncl": 15.00,
            "Mtvh": 15.00,
            "FinancialReductionAmount": 0.00
        },
        {  //VAT Subtotal 2
            "VentilationCode": "1",
            "VATPercentage": 21.00,
            "TotalExcl": 24.00,
            "TotalVAT": 5.04,
            "TotalIncl": 29.04,
            "Mtvh": 24.00,
            "FinancialReductionAmount": 0.00
        }
    ],
    "VentilationCode": "1", 
    "TotalExcl": 39.00, //total of the invoice, excl. VAT
    "TotalIncl": 44.04, //total of the invoice, incl. VAT
    "TotalVAT": 5.04,   //total VAT amount
    "Reference": "45123456789aji", //Purchase Order Number of the Supplier
    "Tags": [],
    "PaymentReference": "+++012/3623/61525+++",  // If supplier has mentioned a unique reference, this is store here
    "Paid": false,  //true if the invoice is Fully Prepaid
    "ExternalProvider": "Peppol", //Invoice is received via the Channel Peppol.
    "ExternalProviderReferences": [],
    "Comments": "header note description", //In case of Peppol this is the content of Note.  Free text info mentioned by the Supplier.
    "Currency": "EUR", //Currency of the Invoice
    "IsSent": false,
    "Invoiced": false,
    "CustomFields": {}, //When specific additional fields are delivered
    "PeriodFrom": "2025-04-01T00:00:00",  //Start period of the services for this invoice/creditnote 
    "PeriodTill": "2025-04-30T00:00:00",  //End period of the services for this invoice/creditnote 
    "RemindersSent": 0,
    "ToPay": 44.04,  //if no prepayment, then this is the full amount of the invoice
    "OrderStatus": "ToPay", 
    "Overdue": false,
    "DaysOverdue": -32,
    "FXRateToForeign": 1.00000,
    "DeliveryDate": "2025-04-25T00:00:00",  //date when the goods were delivered
    "PaymentLinks": [],
    "AccountantVerificationNeeded": false,
    "CurrentDocumentDeliveryDetails": {
        "IsDocumentDelivered": false
    },
    "Messages": []
}

Information about the files

The Json response does only contain a reference to additional files, not the physical file.