POST api/InvoiceExtract

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LicenseKey	string	None.
CompanyId	string	None.
SiteId	string	None.
ExtractHeaders	Collection of string	None.
ExtractHeadersInternal	Collection of string	None.
InvoiceNumber	integer	None.
Organisations	Collection of BillingOrganisation	None.
Companies	Collection of SelectListItem	None.
Firms	Collection of SelectListItem	None.
Invoices	Collection of InvoiceData	None.

Request Formats

application/json, text/json

Sample:

{
  "LicenseKey": "sample string 1",
  "CompanyId": "sample string 2",
  "SiteId": "sample string 3",
  "ExtractHeaders": [
    "sample string 1",
    "sample string 2"
  ],
  "ExtractHeadersInternal": [
    "sample string 1",
    "sample string 2"
  ],
  "InvoiceNumber": 4,
  "Organisations": [
    {
      "Id": 1,
      "OrganisationName": "sample string 2",
      "Postcode": "sample string 3",
      "FlatNumber": "sample string 4",
      "BuildingName": "sample string 5",
      "BuildingNumber": "sample string 6",
      "StreetName": "sample string 7",
      "Town": "sample string 8",
      "County": "sample string 9",
      "CountryString": "sample string 10",
      "Country": 1,
      "Email": "sample string 11",
      "Phone": "sample string 12",
      "CreateDate": "2025-05-04T08:11:42.5161827+01:00",
      "ModifiedDate": "2025-05-04T08:11:42.5161827+01:00",
      "OrganisationType": 0,
      "Location": "sample string 13"
    },
    {
      "Id": 1,
      "OrganisationName": "sample string 2",
      "Postcode": "sample string 3",
      "FlatNumber": "sample string 4",
      "BuildingName": "sample string 5",
      "BuildingNumber": "sample string 6",
      "StreetName": "sample string 7",
      "Town": "sample string 8",
      "County": "sample string 9",
      "CountryString": "sample string 10",
      "Country": 1,
      "Email": "sample string 11",
      "Phone": "sample string 12",
      "CreateDate": "2025-05-04T08:11:42.5161827+01:00",
      "ModifiedDate": "2025-05-04T08:11:42.5161827+01:00",
      "OrganisationType": 0,
      "Location": "sample string 13"
    }
  ],
  "Companies": [
    {
      "Disabled": true,
      "Group": {
        "Disabled": true,
        "Name": "sample string 2"
      },
      "Selected": true,
      "Text": "sample string 3",
      "Value": "sample string 4"
    },
    {
      "Disabled": true,
      "Group": {
        "Disabled": true,
        "Name": "sample string 2"
      },
      "Selected": true,
      "Text": "sample string 3",
      "Value": "sample string 4"
    }
  ],
  "Firms": [
    {
      "Disabled": true,
      "Group": {
        "Disabled": true,
        "Name": "sample string 2"
      },
      "Selected": true,
      "Text": "sample string 3",
      "Value": "sample string 4"
    },
    {
      "Disabled": true,
      "Group": {
        "Disabled": true,
        "Name": "sample string 2"
      },
      "Selected": true,
      "Text": "sample string 3",
      "Value": "sample string 4"
    }
  ],
  "Invoices": [
    {
      "Invoice": {
        "Id": 1,
        "BillingOrganisationId": 2,
        "TotalAmount": 3.0,
        "InvoiceDate": "2025-05-04T08:11:42.5161827+01:00",
        "DueBy": "2025-05-04T08:11:42.5161827+01:00",
        "InvoiceStatus": 0,
        "DeletedReason": 0,
        "UserNumber": 6
      },
      "Contracts": [
        {
          "Id": 1,
          "BillingContractId": 2,
          "BillingInvoiceId": 3,
          "CompanyId": 4,
          "FirmId": 1,
          "StartDate": "2025-05-04T08:11:42.5161827+01:00",
          "EndDate": "2025-05-04T08:11:42.5161827+01:00",
          "Details": "sample string 6",
          "TotalAmount": 7.0,
          "Email": "sample string 8"
        },
        {
          "Id": 1,
          "BillingContractId": 2,
          "BillingInvoiceId": 3,
          "CompanyId": 4,
          "FirmId": 1,
          "StartDate": "2025-05-04T08:11:42.5161827+01:00",
          "EndDate": "2025-05-04T08:11:42.5161827+01:00",
          "Details": "sample string 6",
          "TotalAmount": 7.0,
          "Email": "sample string 8"
        }
      ],
      "ContractCompanyFirms": [
        {
          "BillingInvoiceContractId": 1,
          "CompanyId": 2,
          "FirmId": 3
        },
        {
          "BillingInvoiceContractId": 1,
          "CompanyId": 2,
          "FirmId": 3
        }
      ],
      "ContractFees": [
        {
          "Id": 1,
          "BillingInvoiceContractId": 2,
          "FeeType": 0,
          "FeeAmount": 3.0,
          "Details": "sample string 4"
        },
        {
          "Id": 1,
          "BillingInvoiceContractId": 2,
          "FeeType": 0,
          "FeeAmount": 3.0,
          "Details": "sample string 4"
        }
      ],
      "ContractFeeDetails": [
        {
          "BillingInvoiceContractFeeId": 1,
          "FeeData": "sample string 2"
        },
        {
          "BillingInvoiceContractFeeId": 1,
          "FeeData": "sample string 2"
        }
      ]
    },
    {
      "Invoice": {
        "Id": 1,
        "BillingOrganisationId": 2,
        "TotalAmount": 3.0,
        "InvoiceDate": "2025-05-04T08:11:42.5161827+01:00",
        "DueBy": "2025-05-04T08:11:42.5161827+01:00",
        "InvoiceStatus": 0,
        "DeletedReason": 0,
        "UserNumber": 6
      },
      "Contracts": [
        {
          "Id": 1,
          "BillingContractId": 2,
          "BillingInvoiceId": 3,
          "CompanyId": 4,
          "FirmId": 1,
          "StartDate": "2025-05-04T08:11:42.5161827+01:00",
          "EndDate": "2025-05-04T08:11:42.5161827+01:00",
          "Details": "sample string 6",
          "TotalAmount": 7.0,
          "Email": "sample string 8"
        },
        {
          "Id": 1,
          "BillingContractId": 2,
          "BillingInvoiceId": 3,
          "CompanyId": 4,
          "FirmId": 1,
          "StartDate": "2025-05-04T08:11:42.5161827+01:00",
          "EndDate": "2025-05-04T08:11:42.5161827+01:00",
          "Details": "sample string 6",
          "TotalAmount": 7.0,
          "Email": "sample string 8"
        }
      ],
      "ContractCompanyFirms": [
        {
          "BillingInvoiceContractId": 1,
          "CompanyId": 2,
          "FirmId": 3
        },
        {
          "BillingInvoiceContractId": 1,
          "CompanyId": 2,
          "FirmId": 3
        }
      ],
      "ContractFees": [
        {
          "Id": 1,
          "BillingInvoiceContractId": 2,
          "FeeType": 0,
          "FeeAmount": 3.0,
          "Details": "sample string 4"
        },
        {
          "Id": 1,
          "BillingInvoiceContractId": 2,
          "FeeType": 0,
          "FeeAmount": 3.0,
          "Details": "sample string 4"
        }
      ],
      "ContractFeeDetails": [
        {
          "BillingInvoiceContractFeeId": 1,
          "FeeData": "sample string 2"
        },
        {
          "BillingInvoiceContractFeeId": 1,
          "FeeData": "sample string 2"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceExtract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.ViewModel">
  <Companies xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
    <d2p1:SelectListItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:Group>
        <d2p1:Disabled>true</d2p1:Disabled>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Group>
      <d2p1:Selected>true</d2p1:Selected>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:SelectListItem>
    <d2p1:SelectListItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:Group>
        <d2p1:Disabled>true</d2p1:Disabled>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Group>
      <d2p1:Selected>true</d2p1:Selected>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:SelectListItem>
  </Companies>
  <CompanyId>sample string 2</CompanyId>
  <ExtractHeaders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExtractHeaders>
  <ExtractHeadersInternal xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExtractHeadersInternal>
  <Firms xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Web.Mvc">
    <d2p1:SelectListItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:Group>
        <d2p1:Disabled>true</d2p1:Disabled>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Group>
      <d2p1:Selected>true</d2p1:Selected>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:SelectListItem>
    <d2p1:SelectListItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:Group>
        <d2p1:Disabled>true</d2p1:Disabled>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:Group>
      <d2p1:Selected>true</d2p1:Selected>
      <d2p1:Text>sample string 3</d2p1:Text>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:SelectListItem>
  </Firms>
  <InvoiceNumber>4</InvoiceNumber>
  <Invoices>
    <InvoiceData>
      <ContractCompanyFirms xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractCompanyFirm>
          <d4p1:BillingInvoiceContractId>1</d4p1:BillingInvoiceContractId>
          <d4p1:CompanyId>2</d4p1:CompanyId>
          <d4p1:FirmId>3</d4p1:FirmId>
        </d4p1:BillingInvoiceContractCompanyFirm>
        <d4p1:BillingInvoiceContractCompanyFirm>
          <d4p1:BillingInvoiceContractId>1</d4p1:BillingInvoiceContractId>
          <d4p1:CompanyId>2</d4p1:CompanyId>
          <d4p1:FirmId>3</d4p1:FirmId>
        </d4p1:BillingInvoiceContractCompanyFirm>
      </ContractCompanyFirms>
      <ContractFeeDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractFeeDetail>
          <d4p1:BillingInvoiceContractFeeId>1</d4p1:BillingInvoiceContractFeeId>
          <d4p1:FeeData>sample string 2</d4p1:FeeData>
        </d4p1:BillingInvoiceContractFeeDetail>
        <d4p1:BillingInvoiceContractFeeDetail>
          <d4p1:BillingInvoiceContractFeeId>1</d4p1:BillingInvoiceContractFeeId>
          <d4p1:FeeData>sample string 2</d4p1:FeeData>
        </d4p1:BillingInvoiceContractFeeDetail>
      </ContractFeeDetails>
      <ContractFees xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractFee>
          <d4p1:BillingInvoiceContractId>2</d4p1:BillingInvoiceContractId>
          <d4p1:Details>sample string 4</d4p1:Details>
          <d4p1:FeeAmount>3</d4p1:FeeAmount>
          <d4p1:FeeType>Flat</d4p1:FeeType>
          <d4p1:Id>1</d4p1:Id>
        </d4p1:BillingInvoiceContractFee>
        <d4p1:BillingInvoiceContractFee>
          <d4p1:BillingInvoiceContractId>2</d4p1:BillingInvoiceContractId>
          <d4p1:Details>sample string 4</d4p1:Details>
          <d4p1:FeeAmount>3</d4p1:FeeAmount>
          <d4p1:FeeType>Flat</d4p1:FeeType>
          <d4p1:Id>1</d4p1:Id>
        </d4p1:BillingInvoiceContractFee>
      </ContractFees>
      <Contracts xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContract>
          <d4p1:BillingContractId>2</d4p1:BillingContractId>
          <d4p1:BillingInvoiceId>3</d4p1:BillingInvoiceId>
          <d4p1:CompanyId>4</d4p1:CompanyId>
          <d4p1:Details>sample string 6</d4p1:Details>
          <d4p1:Email>sample string 8</d4p1:Email>
          <d4p1:EndDate>2025-05-04T08:11:42.5161827+01:00</d4p1:EndDate>
          <d4p1:FirmId>1</d4p1:FirmId>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:StartDate>2025-05-04T08:11:42.5161827+01:00</d4p1:StartDate>
          <d4p1:TotalAmount>7</d4p1:TotalAmount>
        </d4p1:BillingInvoiceContract>
        <d4p1:BillingInvoiceContract>
          <d4p1:BillingContractId>2</d4p1:BillingContractId>
          <d4p1:BillingInvoiceId>3</d4p1:BillingInvoiceId>
          <d4p1:CompanyId>4</d4p1:CompanyId>
          <d4p1:Details>sample string 6</d4p1:Details>
          <d4p1:Email>sample string 8</d4p1:Email>
          <d4p1:EndDate>2025-05-04T08:11:42.5161827+01:00</d4p1:EndDate>
          <d4p1:FirmId>1</d4p1:FirmId>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:StartDate>2025-05-04T08:11:42.5161827+01:00</d4p1:StartDate>
          <d4p1:TotalAmount>7</d4p1:TotalAmount>
        </d4p1:BillingInvoiceContract>
      </Contracts>
      <Invoice xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingOrganisationId>2</d4p1:BillingOrganisationId>
        <d4p1:DeletedReason>IncorrectValue</d4p1:DeletedReason>
        <d4p1:DueBy>2025-05-04T08:11:42.5161827+01:00</d4p1:DueBy>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:InvoiceDate>2025-05-04T08:11:42.5161827+01:00</d4p1:InvoiceDate>
        <d4p1:InvoiceStatus>Pending</d4p1:InvoiceStatus>
        <d4p1:TotalAmount>3</d4p1:TotalAmount>
        <d4p1:UserNumber>6</d4p1:UserNumber>
      </Invoice>
    </InvoiceData>
    <InvoiceData>
      <ContractCompanyFirms xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractCompanyFirm>
          <d4p1:BillingInvoiceContractId>1</d4p1:BillingInvoiceContractId>
          <d4p1:CompanyId>2</d4p1:CompanyId>
          <d4p1:FirmId>3</d4p1:FirmId>
        </d4p1:BillingInvoiceContractCompanyFirm>
        <d4p1:BillingInvoiceContractCompanyFirm>
          <d4p1:BillingInvoiceContractId>1</d4p1:BillingInvoiceContractId>
          <d4p1:CompanyId>2</d4p1:CompanyId>
          <d4p1:FirmId>3</d4p1:FirmId>
        </d4p1:BillingInvoiceContractCompanyFirm>
      </ContractCompanyFirms>
      <ContractFeeDetails xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractFeeDetail>
          <d4p1:BillingInvoiceContractFeeId>1</d4p1:BillingInvoiceContractFeeId>
          <d4p1:FeeData>sample string 2</d4p1:FeeData>
        </d4p1:BillingInvoiceContractFeeDetail>
        <d4p1:BillingInvoiceContractFeeDetail>
          <d4p1:BillingInvoiceContractFeeId>1</d4p1:BillingInvoiceContractFeeId>
          <d4p1:FeeData>sample string 2</d4p1:FeeData>
        </d4p1:BillingInvoiceContractFeeDetail>
      </ContractFeeDetails>
      <ContractFees xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContractFee>
          <d4p1:BillingInvoiceContractId>2</d4p1:BillingInvoiceContractId>
          <d4p1:Details>sample string 4</d4p1:Details>
          <d4p1:FeeAmount>3</d4p1:FeeAmount>
          <d4p1:FeeType>Flat</d4p1:FeeType>
          <d4p1:Id>1</d4p1:Id>
        </d4p1:BillingInvoiceContractFee>
        <d4p1:BillingInvoiceContractFee>
          <d4p1:BillingInvoiceContractId>2</d4p1:BillingInvoiceContractId>
          <d4p1:Details>sample string 4</d4p1:Details>
          <d4p1:FeeAmount>3</d4p1:FeeAmount>
          <d4p1:FeeType>Flat</d4p1:FeeType>
          <d4p1:Id>1</d4p1:Id>
        </d4p1:BillingInvoiceContractFee>
      </ContractFees>
      <Contracts xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingInvoiceContract>
          <d4p1:BillingContractId>2</d4p1:BillingContractId>
          <d4p1:BillingInvoiceId>3</d4p1:BillingInvoiceId>
          <d4p1:CompanyId>4</d4p1:CompanyId>
          <d4p1:Details>sample string 6</d4p1:Details>
          <d4p1:Email>sample string 8</d4p1:Email>
          <d4p1:EndDate>2025-05-04T08:11:42.5161827+01:00</d4p1:EndDate>
          <d4p1:FirmId>1</d4p1:FirmId>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:StartDate>2025-05-04T08:11:42.5161827+01:00</d4p1:StartDate>
          <d4p1:TotalAmount>7</d4p1:TotalAmount>
        </d4p1:BillingInvoiceContract>
        <d4p1:BillingInvoiceContract>
          <d4p1:BillingContractId>2</d4p1:BillingContractId>
          <d4p1:BillingInvoiceId>3</d4p1:BillingInvoiceId>
          <d4p1:CompanyId>4</d4p1:CompanyId>
          <d4p1:Details>sample string 6</d4p1:Details>
          <d4p1:Email>sample string 8</d4p1:Email>
          <d4p1:EndDate>2025-05-04T08:11:42.5161827+01:00</d4p1:EndDate>
          <d4p1:FirmId>1</d4p1:FirmId>
          <d4p1:Id>1</d4p1:Id>
          <d4p1:StartDate>2025-05-04T08:11:42.5161827+01:00</d4p1:StartDate>
          <d4p1:TotalAmount>7</d4p1:TotalAmount>
        </d4p1:BillingInvoiceContract>
      </Contracts>
      <Invoice xmlns:d4p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
        <d4p1:BillingOrganisationId>2</d4p1:BillingOrganisationId>
        <d4p1:DeletedReason>IncorrectValue</d4p1:DeletedReason>
        <d4p1:DueBy>2025-05-04T08:11:42.5161827+01:00</d4p1:DueBy>
        <d4p1:Id>1</d4p1:Id>
        <d4p1:InvoiceDate>2025-05-04T08:11:42.5161827+01:00</d4p1:InvoiceDate>
        <d4p1:InvoiceStatus>Pending</d4p1:InvoiceStatus>
        <d4p1:TotalAmount>3</d4p1:TotalAmount>
        <d4p1:UserNumber>6</d4p1:UserNumber>
      </Invoice>
    </InvoiceData>
  </Invoices>
  <LicenseKey>sample string 1</LicenseKey>
  <Organisations xmlns:d2p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Billing.DataModel">
    <d2p1:BillingOrganisation>
      <d2p1:BuildingName>sample string 5</d2p1:BuildingName>
      <d2p1:BuildingNumber>sample string 6</d2p1:BuildingNumber>
      <d2p1:Country>GB</d2p1:Country>
      <d2p1:CountryString>sample string 10</d2p1:CountryString>
      <d2p1:County>sample string 9</d2p1:County>
      <d2p1:CreateDate>2025-05-04T08:11:42.5161827+01:00</d2p1:CreateDate>
      <d2p1:Email>sample string 11</d2p1:Email>
      <d2p1:FlatNumber>sample string 4</d2p1:FlatNumber>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Location>sample string 13</d2p1:Location>
      <d2p1:ModifiedDate>2025-05-04T08:11:42.5161827+01:00</d2p1:ModifiedDate>
      <d2p1:OrganisationName>sample string 2</d2p1:OrganisationName>
      <d2p1:OrganisationType>Intermediary</d2p1:OrganisationType>
      <d2p1:Phone>sample string 12</d2p1:Phone>
      <d2p1:Postcode>sample string 3</d2p1:Postcode>
      <d2p1:StreetName>sample string 7</d2p1:StreetName>
      <d2p1:Town>sample string 8</d2p1:Town>
    </d2p1:BillingOrganisation>
    <d2p1:BillingOrganisation>
      <d2p1:BuildingName>sample string 5</d2p1:BuildingName>
      <d2p1:BuildingNumber>sample string 6</d2p1:BuildingNumber>
      <d2p1:Country>GB</d2p1:Country>
      <d2p1:CountryString>sample string 10</d2p1:CountryString>
      <d2p1:County>sample string 9</d2p1:County>
      <d2p1:CreateDate>2025-05-04T08:11:42.5161827+01:00</d2p1:CreateDate>
      <d2p1:Email>sample string 11</d2p1:Email>
      <d2p1:FlatNumber>sample string 4</d2p1:FlatNumber>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Location>sample string 13</d2p1:Location>
      <d2p1:ModifiedDate>2025-05-04T08:11:42.5161827+01:00</d2p1:ModifiedDate>
      <d2p1:OrganisationName>sample string 2</d2p1:OrganisationName>
      <d2p1:OrganisationType>Intermediary</d2p1:OrganisationType>
      <d2p1:Phone>sample string 12</d2p1:Phone>
      <d2p1:Postcode>sample string 3</d2p1:Postcode>
      <d2p1:StreetName>sample string 7</d2p1:StreetName>
      <d2p1:Town>sample string 8</d2p1:Town>
    </d2p1:BillingOrganisation>
  </Organisations>
  <SiteId>sample string 3</SiteId>
</InvoiceExtract>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.