POST api/V3/InvoiceDetails/UploadInvoiceDetails

Upload Previous generated invoices (Max 2000 records can be uploaded in one request)

Request Information

URI Parameters

None.

Body Parameters

Invoice details to be uploaded

Collection of V3.InvoiceDetails
NameDescriptionTypeAdditional information
InvoiceNumber

Invoice Number

 string

Required

String length: inclusive between 1 and 30
FieldUserErpId

Field User ErpId

 string

None.
OrderType

Type of Order

 OrderType

None.
OrderNumber

Order Number as Per FieldAssist Order

 integer

None.
DistributorErpId

Erp Code Of The distributor from where this invoice was generated [Optional]

 string

None.
InvoiceDate

Date of Invoice

 date

None.
RetailerERPId

SAP or ERP id of the outlet/customer

 string

Required

String length: inclusive between 1 and 50
InvoiceSkuDetails

Product Details

 Collection of V3.InvoiceSkuDetails

None.
ReferenceNumber

Invoice Reference Number[Optional]

 string

None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "InvoiceNumber": "sample string 1",
    "FieldUserErpId": "sample string 2",
    "OrderType": "Physical",
    "OrderNumber": 1,
    "DistributorErpId": "sample string 3",
    "InvoiceDate": "2026-01-07T07:08:44.2713243+00:00",
    "RetailerERPId": "sample string 4",
    "InvoiceSkuDetails": [
      {
        "ProductERPId": "sample string 1",
        "BilledPTR": 1.0,
        "Quantity": 1.1
      },
      {
        "ProductERPId": "sample string 1",
        "BilledPTR": 1.0,
        "Quantity": 1.1
      }
    ],
    "ReferenceNumber": "sample string 5"
  },
  {
    "InvoiceNumber": "sample string 1",
    "FieldUserErpId": "sample string 2",
    "OrderType": "Physical",
    "OrderNumber": 1,
    "DistributorErpId": "sample string 3",
    "InvoiceDate": "2026-01-07T07:08:44.2713243+00:00",
    "RetailerERPId": "sample string 4",
    "InvoiceSkuDetails": [
      {
        "ProductERPId": "sample string 1",
        "BilledPTR": 1.0,
        "Quantity": 1.1
      },
      {
        "ProductERPId": "sample string 1",
        "BilledPTR": 1.0,
        "Quantity": 1.1
      }
    ],
    "ReferenceNumber": "sample string 5"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfInvoiceDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.V3.Models">
  <InvoiceDetails>
    <DistributorErpId>sample string 3</DistributorErpId>
    <FieldUserErpId>sample string 2</FieldUserErpId>
    <InvoiceDate>2026-01-07T07:08:44.2713243+00:00</InvoiceDate>
    <InvoiceNumber>sample string 1</InvoiceNumber>
    <InvoiceSkuDetails>
      <InvoiceSkuDetails>
        <BilledPTR>1</BilledPTR>
        <ProductERPId>sample string 1</ProductERPId>
        <Quantity>1.1</Quantity>
      </InvoiceSkuDetails>
      <InvoiceSkuDetails>
        <BilledPTR>1</BilledPTR>
        <ProductERPId>sample string 1</ProductERPId>
        <Quantity>1.1</Quantity>
      </InvoiceSkuDetails>
    </InvoiceSkuDetails>
    <OrderNumber>1</OrderNumber>
    <OrderType>Physical</OrderType>
    <ReferenceNumber>sample string 5</ReferenceNumber>
    <RetailerERPId>sample string 4</RetailerERPId>
  </InvoiceDetails>
  <InvoiceDetails>
    <DistributorErpId>sample string 3</DistributorErpId>
    <FieldUserErpId>sample string 2</FieldUserErpId>
    <InvoiceDate>2026-01-07T07:08:44.2713243+00:00</InvoiceDate>
    <InvoiceNumber>sample string 1</InvoiceNumber>
    <InvoiceSkuDetails>
      <InvoiceSkuDetails>
        <BilledPTR>1</BilledPTR>
        <ProductERPId>sample string 1</ProductERPId>
        <Quantity>1.1</Quantity>
      </InvoiceSkuDetails>
      <InvoiceSkuDetails>
        <BilledPTR>1</BilledPTR>
        <ProductERPId>sample string 1</ProductERPId>
        <Quantity>1.1</Quantity>
      </InvoiceSkuDetails>
    </InvoiceSkuDetails>
    <OrderNumber>1</OrderNumber>
    <OrderType>Physical</OrderType>
    <ReferenceNumber>sample string 5</ReferenceNumber>
    <RetailerERPId>sample string 4</RetailerERPId>
  </InvoiceDetails>
</ArrayOfInvoiceDetails>

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
Message

Message Indicating the Overall Response Summary of the Requested API

 string

None.
ResponseList

List of Errors

 Collection of ApiResponseMessage

None.
Response

Enum Indicating the Response status

 ResponseStatus

None.
ResponseStatusCount

Summary containing Number of SuccessFull And Failed Tasks

 ResponseStatusCount

None.

Response Formats

application/json, text/json

Sample: 
{
  "Message": "sample string 1",
  "ResponseList": [
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    },
    {
      "ERPId": "sample string 1",
      "Message": "sample string 2",
      "ResponseStatus": "Failure",
      "GUID": "sample string 3"
    }
  ],
  "Response": "Failure",
  "ResponseStatusCount": {
    "Updated": 1,
    "Failed": 2,
    "Ignored": 3,
    "Name": "sample string 1",
    "Total": 6,
    "StatusMessage": "sample string 1: Total-6, Updated-1, Failed-2, Ignored-3",
    "ResponseStatus": "PartialSuccess"
  }
}

application/xml, text/xml

Sample: 
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalApis.Models.Common">
  <Message>sample string 1</Message>
  <Response>Failure</Response>
  <ResponseList>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
    <ApiResponseMessage>
      <ERPId>sample string 1</ERPId>
      <GUID>sample string 3</GUID>
      <Message>sample string 2</Message>
      <ResponseStatus>Failure</ResponseStatus>
    </ApiResponseMessage>
  </ResponseList>
  <ResponseStatusCount>
    <Failed>2</Failed>
    <Ignored>3</Ignored>
    <Name>sample string 1</Name>
    <Updated>1</Updated>
  </ResponseStatusCount>
</ApiResponse>