POST api/Codat/PostPurchaseBill
API to import orders from shopify
Request Information
URI Parameters
None.
Body Parameters
CodatBillRequestModelName | Description | Type | Additional information |
---|---|---|---|
BillID | integer |
None. |
|
BillNo | string |
None. |
|
CodatBillID | string |
None. |
|
CodatSupplierID | string |
None. |
|
CodatSupplierName | 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 CodatBillLineItems |
None. |
Request Formats
application/json, text/json, text/plain, text/html
Sample:
{ "billID": 1, "billNo": "sample string 2", "codatBillID": "sample string 3", "codatSupplierID": "sample string 4", "codatSupplierName": "sample string 5", "issueDate": "2025-07-17T05:09:33.6956114+00:00", "dueDate": "2025-07-17T05:09:33.6956114+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, "codatAccountId": "sample string 6", "codatAccountName": "sample string 7", "codatItemID": "sample string 8", "taxRateID": 9 }, { "description": "sample string 1", "unitPrice": 2.0, "quantity": 3, "subTotal": 4.0, "totalAmount": 5.0, "codatAccountId": "sample string 6", "codatAccountName": "sample string 7", "codatItemID": "sample string 8", "taxRateID": 9 } ] }
application/xml, text/xml
Sample:
<CodatBillRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"> <AmountDue>12</AmountDue> <BillID>1</BillID> <BillNo>sample string 2</BillNo> <CodatBillID>sample string 3</CodatBillID> <CodatSupplierID>sample string 4</CodatSupplierID> <CodatSupplierName>sample string 5</CodatSupplierName> <Currency>sample string 8</Currency> <DueDate>2025-07-17T05:09:33.6956114+00:00</DueDate> <ExchangeRate>9</ExchangeRate> <IssueDate>2025-07-17T05:09:33.6956114+00:00</IssueDate> <Note>sample string 13</Note> <SubTotal>11</SubTotal> <TotalAmount>10</TotalAmount> <items> <CodatBillLineItems> <CodatAccountId>sample string 6</CodatAccountId> <CodatAccountName>sample string 7</CodatAccountName> <CodatItemID>sample string 8</CodatItemID> <Description>sample string 1</Description> <Quantity>3</Quantity> <SubTotal>4</SubTotal> <TaxRateID>9</TaxRateID> <TotalAmount>5</TotalAmount> <UnitPrice>2</UnitPrice> </CodatBillLineItems> <CodatBillLineItems> <CodatAccountId>sample string 6</CodatAccountId> <CodatAccountName>sample string 7</CodatAccountName> <CodatItemID>sample string 8</CodatItemID> <Description>sample string 1</Description> <Quantity>3</Quantity> <SubTotal>4</SubTotal> <TaxRateID>9</TaxRateID> <TotalAmount>5</TotalAmount> <UnitPrice>2</UnitPrice> </CodatBillLineItems> </items> </CodatBillRequestModel>
multipart/form-data
Sample:
<CodatBillRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ATMP.Core.RequestModel"><AmountDue>12</AmountDue><BillID>1</BillID><BillNo>sample string 2</BillNo><CodatBillID>sample string 3</CodatBillID><CodatSupplierID>sample string 4</CodatSupplierID><CodatSupplierName>sample string 5</CodatSupplierName><Currency>sample string 8</Currency><DueDate>2025-07-17T05:09:33.6956114+00:00</DueDate><ExchangeRate>9</ExchangeRate><IssueDate>2025-07-17T05:09:33.6956114+00:00</IssueDate><Note>sample string 13</Note><SubTotal>11</SubTotal><TotalAmount>10</TotalAmount><items><CodatBillLineItems><CodatAccountId>sample string 6</CodatAccountId><CodatAccountName>sample string 7</CodatAccountName><CodatItemID>sample string 8</CodatItemID><Description>sample string 1</Description><Quantity>3</Quantity><SubTotal>4</SubTotal><TaxRateID>9</TaxRateID><TotalAmount>5</TotalAmount><UnitPrice>2</UnitPrice></CodatBillLineItems><CodatBillLineItems><CodatAccountId>sample string 6</CodatAccountId><CodatAccountName>sample string 7</CodatAccountName><CodatItemID>sample string 8</CodatItemID><Description>sample string 1</Description><Quantity>3</Quantity><SubTotal>4</SubTotal><TaxRateID>9</TaxRateID><TotalAmount>5</TotalAmount><UnitPrice>2</UnitPrice></CodatBillLineItems></items></CodatBillRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CommonResponseDataModelName | Description | 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>