GET api/Invoices

Used to fetch the list of invoices for a logged in user

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

COMPLETE

Collection of InvoiceModel

Name	Description	Type	Additional information
EntityCode	Entity code	string	None.
InvoiceID	Invoice ID	integer	None.
InvoiceNumber	Invoice number	string	None.
InvoiceDate	Invoice date	date	None.
DueDate	Due date of invoice	date	None.
TotalBillableAmount	Total Billable Amount	decimal number	None.
TotalCharge	Total charge	decimal number	None.
InvoiceStatus	Status of invoice	string	None.
InvoiceDocuments	List of associated documents for the invoice	Collection of InvoiceDocumentModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EntityCode": "sample string 1",
    "InvoiceID": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceDate": "2024-06-29T07:52:17.0412625+10:00",
    "DueDate": "2024-06-29T07:52:17.0412625+10:00",
    "TotalBillableAmount": 1.0,
    "TotalCharge": 1.0,
    "InvoiceStatus": "sample string 3",
    "InvoiceDocuments": [
      {
        "DocumentID": 1,
        "DocumentType": "sample string 1",
        "FileName": "sample string 2"
      },
      {
        "DocumentID": 1,
        "DocumentType": "sample string 1",
        "FileName": "sample string 2"
      }
    ]
  },
  {
    "EntityCode": "sample string 1",
    "InvoiceID": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceDate": "2024-06-29T07:52:17.0412625+10:00",
    "DueDate": "2024-06-29T07:52:17.0412625+10:00",
    "TotalBillableAmount": 1.0,
    "TotalCharge": 1.0,
    "InvoiceStatus": "sample string 3",
    "InvoiceDocuments": [
      {
        "DocumentID": 1,
        "DocumentType": "sample string 1",
        "FileName": "sample string 2"
      },
      {
        "DocumentID": 1,
        "DocumentType": "sample string 1",
        "FileName": "sample string 2"
      }
    ]
  }
]

text/xml

Sample:

<ArrayOfInvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <InvoiceModel>
    <DueDate>2024-06-29T07:52:17.0412625+10:00</DueDate>
    <EntityCode>sample string 1</EntityCode>
    <InvoiceDate>2024-06-29T07:52:17.0412625+10:00</InvoiceDate>
    <InvoiceDocuments>
      <InvoiceDocumentModel>
        <DocumentID>1</DocumentID>
        <DocumentType>sample string 1</DocumentType>
        <FileName>sample string 2</FileName>
      </InvoiceDocumentModel>
      <InvoiceDocumentModel>
        <DocumentID>1</DocumentID>
        <DocumentType>sample string 1</DocumentType>
        <FileName>sample string 2</FileName>
      </InvoiceDocumentModel>
    </InvoiceDocuments>
    <InvoiceID>1</InvoiceID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceStatus>sample string 3</InvoiceStatus>
    <TotalBillableAmount>1</TotalBillableAmount>
    <TotalCharge>1</TotalCharge>
  </InvoiceModel>
  <InvoiceModel>
    <DueDate>2024-06-29T07:52:17.0412625+10:00</DueDate>
    <EntityCode>sample string 1</EntityCode>
    <InvoiceDate>2024-06-29T07:52:17.0412625+10:00</InvoiceDate>
    <InvoiceDocuments>
      <InvoiceDocumentModel>
        <DocumentID>1</DocumentID>
        <DocumentType>sample string 1</DocumentType>
        <FileName>sample string 2</FileName>
      </InvoiceDocumentModel>
      <InvoiceDocumentModel>
        <DocumentID>1</DocumentID>
        <DocumentType>sample string 1</DocumentType>
        <FileName>sample string 2</FileName>
      </InvoiceDocumentModel>
    </InvoiceDocuments>
    <InvoiceID>1</InvoiceID>
    <InvoiceNumber>sample string 2</InvoiceNumber>
    <InvoiceStatus>sample string 3</InvoiceStatus>
    <TotalBillableAmount>1</TotalBillableAmount>
    <TotalCharge>1</TotalCharge>
  </InvoiceModel>
</ArrayOfInvoiceModel>

multipart/form-data

Sample:

<ArrayOfInvoiceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><InvoiceModel><DueDate>2024-06-29T07:52:17.0412625+10:00</DueDate><EntityCode>sample string 1</EntityCode><InvoiceDate>2024-06-29T07:52:17.0412625+10:00</InvoiceDate><InvoiceDocuments><InvoiceDocumentModel><DocumentID>1</DocumentID><DocumentType>sample string 1</DocumentType><FileName>sample string 2</FileName></InvoiceDocumentModel><InvoiceDocumentModel><DocumentID>1</DocumentID><DocumentType>sample string 1</DocumentType><FileName>sample string 2</FileName></InvoiceDocumentModel></InvoiceDocuments><InvoiceID>1</InvoiceID><InvoiceNumber>sample string 2</InvoiceNumber><InvoiceStatus>sample string 3</InvoiceStatus><TotalBillableAmount>1</TotalBillableAmount><TotalCharge>1</TotalCharge></InvoiceModel><InvoiceModel><DueDate>2024-06-29T07:52:17.0412625+10:00</DueDate><EntityCode>sample string 1</EntityCode><InvoiceDate>2024-06-29T07:52:17.0412625+10:00</InvoiceDate><InvoiceDocuments><InvoiceDocumentModel><DocumentID>1</DocumentID><DocumentType>sample string 1</DocumentType><FileName>sample string 2</FileName></InvoiceDocumentModel><InvoiceDocumentModel><DocumentID>1</DocumentID><DocumentType>sample string 1</DocumentType><FileName>sample string 2</FileName></InvoiceDocumentModel></InvoiceDocuments><InvoiceID>1</InvoiceID><InvoiceNumber>sample string 2</InvoiceNumber><InvoiceStatus>sample string 3</InvoiceStatus><TotalBillableAmount>1</TotalBillableAmount><TotalCharge>1</TotalCharge></InvoiceModel></ArrayOfInvoiceModel>