POST api/Codat/PostInvoice

API to import orders from shopify

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceID	integer	None.
InvoiceNo	string	None.
CodatInvoiceID	string	None.
CodatCustomerID	string	None.
CodatCustomerName	string	None.
IssueDate	date	None.
DueDate	date	None.
Currency	string	None.
ExchangeRate	decimal number	None.
TotalAmount	decimal number	None.
SubTotal	decimal number	None.
AmountDue	decimal number	None.
Note	string	None.
items	Collection of CodatInvoiceLineItems	None.

Request Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "invoiceID": 1,
  "invoiceNo": "sample string 2",
  "codatInvoiceID": "sample string 3",
  "codatCustomerID": "sample string 4",
  "codatCustomerName": "sample string 5",
  "issueDate": "2025-07-17T04:14:45.5017526+00:00",
  "dueDate": "2025-07-17T04:14:45.5017526+00:00",
  "currency": "sample string 8",
  "exchangeRate": 9.0,
  "totalAmount": 10.0,
  "subTotal": 11.0,
  "amountDue": 12.0,
  "note": "sample string 13",
  "items": [
    {
      "description": "sample string 1",
      "unitPrice": 2.0,
      "quantity": 3,
      "subTotal": 4.0,
      "totalAmount": 5.0,
      "codatItemId": "sample string 6",
      "codatItemName": "sample string 7",
      "itemID": "sample string 8"
    },
    {
      "description": "sample string 1",
      "unitPrice": 2.0,
      "quantity": 3,
      "subTotal": 4.0,
      "totalAmount": 5.0,
      "codatItemId": "sample string 6",
      "codatItemName": "sample string 7",
      "itemID": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:

<CodatInvoiceRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel">
  <AmountDue>12</AmountDue>
  <CodatCustomerID>sample string 4</CodatCustomerID>
  <CodatCustomerName>sample string 5</CodatCustomerName>
  <CodatInvoiceID>sample string 3</CodatInvoiceID>
  <Currency>sample string 8</Currency>
  <DueDate>2025-07-17T04:14:45.5017526+00:00</DueDate>
  <ExchangeRate>9</ExchangeRate>
  <InvoiceID>1</InvoiceID>
  <InvoiceNo>sample string 2</InvoiceNo>
  <IssueDate>2025-07-17T04:14:45.5017526+00:00</IssueDate>
  <Note>sample string 13</Note>
  <SubTotal>11</SubTotal>
  <TotalAmount>10</TotalAmount>
  <items>
    <CodatInvoiceLineItems>
      <CodatItemId>sample string 6</CodatItemId>
      <CodatItemName>sample string 7</CodatItemName>
      <Description>sample string 1</Description>
      <ItemID>sample string 8</ItemID>
      <Quantity>3</Quantity>
      <SubTotal>4</SubTotal>
      <TotalAmount>5</TotalAmount>
      <UnitPrice>2</UnitPrice>
    </CodatInvoiceLineItems>
    <CodatInvoiceLineItems>
      <CodatItemId>sample string 6</CodatItemId>
      <CodatItemName>sample string 7</CodatItemName>
      <Description>sample string 1</Description>
      <ItemID>sample string 8</ItemID>
      <Quantity>3</Quantity>
      <SubTotal>4</SubTotal>
      <TotalAmount>5</TotalAmount>
      <UnitPrice>2</UnitPrice>
    </CodatInvoiceLineItems>
  </items>
</CodatInvoiceRequestDataModel>

multipart/form-data

Sample:

<CodatInvoiceRequestDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><AmountDue>12</AmountDue><CodatCustomerID>sample string 4</CodatCustomerID><CodatCustomerName>sample string 5</CodatCustomerName><CodatInvoiceID>sample string 3</CodatInvoiceID><Currency>sample string 8</Currency><DueDate>2025-07-17T04:14:45.5017526+00:00</DueDate><ExchangeRate>9</ExchangeRate><InvoiceID>1</InvoiceID><InvoiceNo>sample string 2</InvoiceNo><IssueDate>2025-07-17T04:14:45.5017526+00:00</IssueDate><Note>sample string 13</Note><SubTotal>11</SubTotal><TotalAmount>10</TotalAmount><items><CodatInvoiceLineItems><CodatItemId>sample string 6</CodatItemId><CodatItemName>sample string 7</CodatItemName><Description>sample string 1</Description><ItemID>sample string 8</ItemID><Quantity>3</Quantity><SubTotal>4</SubTotal><TotalAmount>5</TotalAmount><UnitPrice>2</UnitPrice></CodatInvoiceLineItems><CodatInvoiceLineItems><CodatItemId>sample string 6</CodatItemId><CodatItemName>sample string 7</CodatItemName><Description>sample string 1</Description><ItemID>sample string 8</ItemID><Quantity>3</Quantity><SubTotal>4</SubTotal><TotalAmount>5</TotalAmount><UnitPrice>2</UnitPrice></CodatInvoiceLineItems></items></CodatInvoiceRequestDataModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CommonResponseDataModel

Name	Type	Additional information
ReturnID	integer	Required
Message	string	Required
Successful	boolean	Required
Code	integer	None.
TotalRecord	integer	None.

Response Formats

application/json, text/json, text/plain, text/html

Sample:

{
  "returnID": 1,
  "message": "sample string 2",
  "successful": true,
  "code": 4,
  "totalRecord": 5
}

application/xml, text/xml

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel">
  <Code>4</Code>
  <Message>sample string 2</Message>
  <ReturnID>1</ReturnID>
  <Successful>true</Successful>
  <TotalRecord>5</TotalRecord>
</CommonResponseDataModel>

multipart/form-data

Sample:

<CommonResponseDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.DataModel"><Code>4</Code><Message>sample string 2</Message><ReturnID>1</ReturnID><Successful>true</Successful><TotalRecord>5</TotalRecord></CommonResponseDataModel>