POST API/JobTrak/ImportWasteCustomers

Import Waste Customers for use in Trade Routes

Request Information

URI Parameters

None.

Body Parameters

Customers to import

Collection of WasteCustomer
NameDescriptionTypeAdditional information
CustomerAccountNumber

The Customer Account Number

 string

Required
CustomerName

Name of the customer

 string

Required
AddressLine1

Address Line 1

 string

None.
AddressLine2

Address Line 2

 string

None.
City

City

 string

None.
County

County

 string

None.
Postcode

Postal code

 string

None.
VATNumber

VAT Number

 string

None.
Currency

Customer Currency

 CurrencyID

None.
CompanyRegistrationNumber

The company registration number as specified in the Companies House API

 string

None.
BusinessSector

Business Sector

 string

None.
CustomerAccountReferenceNumber

Account Reference Number

 string

None.
PrimaryContactName

Primary Contact Name

 string

None.
PrimaryContactJobTitle

Primary Contact Job Title

 string

None.
PrimaryContactDepartment

Primary Contact Department

 string

None.
PrimaryContactTelephoneNumber

Primary Contact Telephone Number

 string

None.
PrimaryContactMobileNumber

Primary Contact Mobile Number

 string

None.
PrimaryContactFax

Primary Contact Fax

 string

None.
PrimaryContactEmail

Primary Contact Email

 string

None.
SecondaryContactName

Secondary Contact Name

 string

None.
SecondaryContactJobTitle

Secondary Contact Job Title

 string

None.
SecondaryContactDepartment

Secondary Contact Department

 string

None.
SecondaryContactTelephoneNumber

Secondary Contact Telephone Number

 string

None.
SecondaryContactMobileNumber

Secondary Contact Mobile Number

 string

None.
SecondaryContactFax

Secondary Contact Fax

 string

None.
SecondaryContactEmail

Secondary Contact Email

 string

None.
BankName

Bank Name

 string

None.
BankAccountNumber

Bank Account Number

 string

None.
SortCode

Bank Sort Code

 string

None.
BankAddress1

Bank Address Line 1

 string

None.
BankAddress2

Bank Address Line 2

 string

None.
BankAddress3

Bank Address Line 3

 string

None.
BankPostCode

Bank Post Code

 string

None.
LastInvoiced

Last Invoiced date (requires bank details)

 date

None.
Note

Note on import

 string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "CustomerAccountNumber": "sample string 1",
    "CustomerName": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "City": "sample string 5",
    "County": "sample string 6",
    "Postcode": "sample string 7",
    "VATNumber": "sample string 8",
    "Currency": 1,
    "CompanyRegistrationNumber": "sample string 9",
    "BusinessSector": "sample string 10",
    "CustomerAccountReferenceNumber": "sample string 11",
    "PrimaryContactName": "sample string 12",
    "PrimaryContactJobTitle": "sample string 13",
    "PrimaryContactDepartment": "sample string 14",
    "PrimaryContactTelephoneNumber": "sample string 15",
    "PrimaryContactMobileNumber": "sample string 16",
    "PrimaryContactFax": "sample string 17",
    "PrimaryContactEmail": "sample string 18",
    "SecondaryContactName": "sample string 19",
    "SecondaryContactJobTitle": "sample string 20",
    "SecondaryContactDepartment": "sample string 21",
    "SecondaryContactTelephoneNumber": "sample string 22",
    "SecondaryContactMobileNumber": "sample string 23",
    "SecondaryContactFax": "sample string 24",
    "SecondaryContactEmail": "sample string 25",
    "BankName": "sample string 26",
    "BankAccountNumber": "sample string 27",
    "SortCode": "sample string 28",
    "BankAddress1": "sample string 29",
    "BankAddress2": "sample string 30",
    "BankAddress3": "sample string 31",
    "BankPostCode": "sample string 32",
    "LastInvoiced": "2025-12-14T18:43:12.3825597+00:00",
    "Note": "sample string 33"
  },
  {
    "CustomerAccountNumber": "sample string 1",
    "CustomerName": "sample string 2",
    "AddressLine1": "sample string 3",
    "AddressLine2": "sample string 4",
    "City": "sample string 5",
    "County": "sample string 6",
    "Postcode": "sample string 7",
    "VATNumber": "sample string 8",
    "Currency": 1,
    "CompanyRegistrationNumber": "sample string 9",
    "BusinessSector": "sample string 10",
    "CustomerAccountReferenceNumber": "sample string 11",
    "PrimaryContactName": "sample string 12",
    "PrimaryContactJobTitle": "sample string 13",
    "PrimaryContactDepartment": "sample string 14",
    "PrimaryContactTelephoneNumber": "sample string 15",
    "PrimaryContactMobileNumber": "sample string 16",
    "PrimaryContactFax": "sample string 17",
    "PrimaryContactEmail": "sample string 18",
    "SecondaryContactName": "sample string 19",
    "SecondaryContactJobTitle": "sample string 20",
    "SecondaryContactDepartment": "sample string 21",
    "SecondaryContactTelephoneNumber": "sample string 22",
    "SecondaryContactMobileNumber": "sample string 23",
    "SecondaryContactFax": "sample string 24",
    "SecondaryContactEmail": "sample string 25",
    "BankName": "sample string 26",
    "BankAccountNumber": "sample string 27",
    "SortCode": "sample string 28",
    "BankAddress1": "sample string 29",
    "BankAddress2": "sample string 30",
    "BankAddress3": "sample string 31",
    "BankPostCode": "sample string 32",
    "LastInvoiced": "2025-12-14T18:43:12.3825597+00:00",
    "Note": "sample string 33"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWasteCustomer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WasteCustomer>
    <CustomerAccountNumber>sample string 1</CustomerAccountNumber>
    <CustomerName>sample string 2</CustomerName>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <City>sample string 5</City>
    <County>sample string 6</County>
    <Postcode>sample string 7</Postcode>
    <VATNumber>sample string 8</VATNumber>
    <Currency>GBP</Currency>
    <CompanyRegistrationNumber>sample string 9</CompanyRegistrationNumber>
    <BusinessSector>sample string 10</BusinessSector>
    <CustomerAccountReferenceNumber>sample string 11</CustomerAccountReferenceNumber>
    <PrimaryContactName>sample string 12</PrimaryContactName>
    <PrimaryContactJobTitle>sample string 13</PrimaryContactJobTitle>
    <PrimaryContactDepartment>sample string 14</PrimaryContactDepartment>
    <PrimaryContactTelephoneNumber>sample string 15</PrimaryContactTelephoneNumber>
    <PrimaryContactMobileNumber>sample string 16</PrimaryContactMobileNumber>
    <PrimaryContactFax>sample string 17</PrimaryContactFax>
    <PrimaryContactEmail>sample string 18</PrimaryContactEmail>
    <SecondaryContactName>sample string 19</SecondaryContactName>
    <SecondaryContactJobTitle>sample string 20</SecondaryContactJobTitle>
    <SecondaryContactDepartment>sample string 21</SecondaryContactDepartment>
    <SecondaryContactTelephoneNumber>sample string 22</SecondaryContactTelephoneNumber>
    <SecondaryContactMobileNumber>sample string 23</SecondaryContactMobileNumber>
    <SecondaryContactFax>sample string 24</SecondaryContactFax>
    <SecondaryContactEmail>sample string 25</SecondaryContactEmail>
    <BankName>sample string 26</BankName>
    <BankAccountNumber>sample string 27</BankAccountNumber>
    <SortCode>sample string 28</SortCode>
    <BankAddress1>sample string 29</BankAddress1>
    <BankAddress2>sample string 30</BankAddress2>
    <BankAddress3>sample string 31</BankAddress3>
    <BankPostCode>sample string 32</BankPostCode>
    <LastInvoiced>2025-12-14T18:43:12.3825597+00:00</LastInvoiced>
    <Note>sample string 33</Note>
  </WasteCustomer>
  <WasteCustomer>
    <CustomerAccountNumber>sample string 1</CustomerAccountNumber>
    <CustomerName>sample string 2</CustomerName>
    <AddressLine1>sample string 3</AddressLine1>
    <AddressLine2>sample string 4</AddressLine2>
    <City>sample string 5</City>
    <County>sample string 6</County>
    <Postcode>sample string 7</Postcode>
    <VATNumber>sample string 8</VATNumber>
    <Currency>GBP</Currency>
    <CompanyRegistrationNumber>sample string 9</CompanyRegistrationNumber>
    <BusinessSector>sample string 10</BusinessSector>
    <CustomerAccountReferenceNumber>sample string 11</CustomerAccountReferenceNumber>
    <PrimaryContactName>sample string 12</PrimaryContactName>
    <PrimaryContactJobTitle>sample string 13</PrimaryContactJobTitle>
    <PrimaryContactDepartment>sample string 14</PrimaryContactDepartment>
    <PrimaryContactTelephoneNumber>sample string 15</PrimaryContactTelephoneNumber>
    <PrimaryContactMobileNumber>sample string 16</PrimaryContactMobileNumber>
    <PrimaryContactFax>sample string 17</PrimaryContactFax>
    <PrimaryContactEmail>sample string 18</PrimaryContactEmail>
    <SecondaryContactName>sample string 19</SecondaryContactName>
    <SecondaryContactJobTitle>sample string 20</SecondaryContactJobTitle>
    <SecondaryContactDepartment>sample string 21</SecondaryContactDepartment>
    <SecondaryContactTelephoneNumber>sample string 22</SecondaryContactTelephoneNumber>
    <SecondaryContactMobileNumber>sample string 23</SecondaryContactMobileNumber>
    <SecondaryContactFax>sample string 24</SecondaryContactFax>
    <SecondaryContactEmail>sample string 25</SecondaryContactEmail>
    <BankName>sample string 26</BankName>
    <BankAccountNumber>sample string 27</BankAccountNumber>
    <SortCode>sample string 28</SortCode>
    <BankAddress1>sample string 29</BankAddress1>
    <BankAddress2>sample string 30</BankAddress2>
    <BankAddress3>sample string 31</BankAddress3>
    <BankPostCode>sample string 32</BankPostCode>
    <LastInvoiced>2025-12-14T18:43:12.3825597+00:00</LastInvoiced>
    <Note>sample string 33</Note>
  </WasteCustomer>
</ArrayOfWasteCustomer>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Response from the server

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.