POST api/Transaction/PostAPInvoice?APIKey={APIKey}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| APIKey | string |
Required |
Body Parameters
TransactionInfoViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| InvoiceNumber | string |
Required |
|
| Description | string |
None. |
|
| OrganizationCode | string |
Required |
|
| OSCurrencyCode | string |
Required |
|
| OSExGSTVATAmount | decimal number |
Required |
|
| OSGSTVATAmount | decimal number |
None. |
|
| OSTotal | decimal number |
Required |
|
| TransactionDate | string |
None. |
|
| PostingJournals | Collection of PostingJournalViewModel |
Required |
|
| AttachedDocuments | Collection of AttachedDocumentViewModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"InvoiceNumber": "sample string 1",
"Description": "sample string 2",
"OrganizationCode": "sample string 3",
"OSCurrencyCode": "sample string 4",
"OSExGSTVATAmount": 5.0,
"OSGSTVATAmount": 1.0,
"OSTotal": 6.0,
"TransactionDate": "sample string 7",
"PostingJournals": [
{
"JobNo": "sample string 1",
"OrganizationCode": "sample string 2",
"BranchCode": "sample string 3",
"BranchName": "sample string 4",
"DepartmentCode": "sample string 5",
"DepartmentName": "sample string 6",
"ChargeCode": "sample string 7",
"OSAmount": 8.0,
"OSCurrencyCode": "sample string 9",
"OSTotalAmount": 1.0,
"TransactionCategory": "sample string 10",
"TransactionType": "sample string 11",
"OSGSTVATAmount": 1.0
},
{
"JobNo": "sample string 1",
"OrganizationCode": "sample string 2",
"BranchCode": "sample string 3",
"BranchName": "sample string 4",
"DepartmentCode": "sample string 5",
"DepartmentName": "sample string 6",
"ChargeCode": "sample string 7",
"OSAmount": 8.0,
"OSCurrencyCode": "sample string 9",
"OSTotalAmount": 1.0,
"TransactionCategory": "sample string 10",
"TransactionType": "sample string 11",
"OSGSTVATAmount": 1.0
}
],
"AttachedDocuments": [
{
"FileName": "sample string 1",
"ImageData": "sample string 2",
"IsPublished": "sample string 3"
},
{
"FileName": "sample string 1",
"ImageData": "sample string 2",
"IsPublished": "sample string 3"
}
]
}
application/xml, text/xml
Sample:
<TransactionInfoViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CW1_API.Models.ViewModel">
<AttachedDocuments>
<AttachedDocumentViewModel>
<FileName>sample string 1</FileName>
<ImageData>sample string 2</ImageData>
<IsPublished>sample string 3</IsPublished>
</AttachedDocumentViewModel>
<AttachedDocumentViewModel>
<FileName>sample string 1</FileName>
<ImageData>sample string 2</ImageData>
<IsPublished>sample string 3</IsPublished>
</AttachedDocumentViewModel>
</AttachedDocuments>
<Description>sample string 2</Description>
<InvoiceNumber>sample string 1</InvoiceNumber>
<OSCurrencyCode>sample string 4</OSCurrencyCode>
<OSExGSTVATAmount>5</OSExGSTVATAmount>
<OSGSTVATAmount>1</OSGSTVATAmount>
<OSTotal>6</OSTotal>
<OrganizationCode>sample string 3</OrganizationCode>
<PostingJournals>
<PostingJournalViewModel>
<BranchCode>sample string 3</BranchCode>
<BranchName>sample string 4</BranchName>
<ChargeCode>sample string 7</ChargeCode>
<DepartmentCode>sample string 5</DepartmentCode>
<DepartmentName>sample string 6</DepartmentName>
<JobNo>sample string 1</JobNo>
<OSAmount>8</OSAmount>
<OSCurrencyCode>sample string 9</OSCurrencyCode>
<OSGSTVATAmount>1</OSGSTVATAmount>
<OSTotalAmount>1</OSTotalAmount>
<OrganizationCode>sample string 2</OrganizationCode>
<TransactionCategory>sample string 10</TransactionCategory>
<TransactionType>sample string 11</TransactionType>
</PostingJournalViewModel>
<PostingJournalViewModel>
<BranchCode>sample string 3</BranchCode>
<BranchName>sample string 4</BranchName>
<ChargeCode>sample string 7</ChargeCode>
<DepartmentCode>sample string 5</DepartmentCode>
<DepartmentName>sample string 6</DepartmentName>
<JobNo>sample string 1</JobNo>
<OSAmount>8</OSAmount>
<OSCurrencyCode>sample string 9</OSCurrencyCode>
<OSGSTVATAmount>1</OSGSTVATAmount>
<OSTotalAmount>1</OSTotalAmount>
<OrganizationCode>sample string 2</OrganizationCode>
<TransactionCategory>sample string 10</TransactionCategory>
<TransactionType>sample string 11</TransactionType>
</PostingJournalViewModel>
</PostingJournals>
<TransactionDate>sample string 7</TransactionDate>
</TransactionInfoViewModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | 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. |