POST api/invoices/methods
Invoices with their method types will be returned
Request Information
URI Parameters
None.
Body Parameters
MethodCheck| Name | Description | Type | Additional information |
|---|---|---|---|
| DueDate |
The Due Date for this batch of Invoices. Should match the Invoice Date to be sent for processing. |
string |
Required |
| Invoices |
The Invoices to be checked for Payment Method type. |
Collection of Invoice |
Required |
Request Formats
application/json, text/json
Sample:
{
"DueDate": "sample string 1",
"Invoices": [
{
"MemberNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"MethodType": "sample string 3",
"LocationId": "sample string 4",
"LocationTaxRate": "sample string 5",
"Multiplier": "sample string 6"
},
{
"MemberNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"MethodType": "sample string 3",
"LocationId": "sample string 4",
"LocationTaxRate": "sample string 5",
"Multiplier": "sample string 6"
}
]
}
text/xml
Sample:
<MethodCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oracle_API.Models">
<DueDate>sample string 1</DueDate>
<Invoices>
<Invoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<LocationId>sample string 4</LocationId>
<LocationTaxRate>sample string 5</LocationTaxRate>
<MemberNumber>sample string 1</MemberNumber>
<MethodType>sample string 3</MethodType>
<Multiplier>sample string 6</Multiplier>
</Invoice>
<Invoice>
<InvoiceNumber>sample string 2</InvoiceNumber>
<LocationId>sample string 4</LocationId>
<LocationTaxRate>sample string 5</LocationTaxRate>
<MemberNumber>sample string 1</MemberNumber>
<MethodType>sample string 3</MethodType>
<Multiplier>sample string 6</Multiplier>
</Invoice>
</Invoices>
</MethodCheck>
multipart/form-data
Sample:
<MethodCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oracle_API.Models"><DueDate>sample string 1</DueDate><Invoices><Invoice><InvoiceNumber>sample string 2</InvoiceNumber><LocationId>sample string 4</LocationId><LocationTaxRate>sample string 5</LocationTaxRate><MemberNumber>sample string 1</MemberNumber><MethodType>sample string 3</MethodType><Multiplier>sample string 6</Multiplier></Invoice><Invoice><InvoiceNumber>sample string 2</InvoiceNumber><LocationId>sample string 4</LocationId><LocationTaxRate>sample string 5</LocationTaxRate><MemberNumber>sample string 1</MemberNumber><MethodType>sample string 3</MethodType><Multiplier>sample string 6</Multiplier></Invoice></Invoices></MethodCheck>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
MethodsGetResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Data |
Retreive a List of method types by Member |
Collection of InvoiceResponse |
None. |
| Success |
Returns true if the call was a success |
boolean |
None. |
| Httpcode |
Returns the Http Status Code from the response |
string |
None. |
| Httpstatus |
Returns the Http Status Title from the response |
string |
None. |
| Message |
Returns the Status Message from the response. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Httpcode": "sample string 2",
"Httpstatus": "sample string 3",
"Message": "sample string 4",
"Data": [
{
"MemberNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"MethodType": "sample string 3",
"AdminFees": 4.0,
"TaxAmount": 5.0,
"TotalAdminFees": 6.0
},
{
"MemberNumber": "sample string 1",
"InvoiceNumber": "sample string 2",
"MethodType": "sample string 3",
"AdminFees": 4.0,
"TaxAmount": 5.0,
"TotalAdminFees": 6.0
}
]
}
text/xml
Sample:
<MethodsGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oracle_API.Models">
<Httpcode>sample string 2</Httpcode>
<Httpstatus>sample string 3</Httpstatus>
<Message>sample string 4</Message>
<Success>true</Success>
<Data>
<InvoiceResponse>
<AdminFees>4</AdminFees>
<InvoiceNumber>sample string 2</InvoiceNumber>
<MemberNumber>sample string 1</MemberNumber>
<MethodType>sample string 3</MethodType>
<TaxAmount>5</TaxAmount>
<TotalAdminFees>6</TotalAdminFees>
</InvoiceResponse>
<InvoiceResponse>
<AdminFees>4</AdminFees>
<InvoiceNumber>sample string 2</InvoiceNumber>
<MemberNumber>sample string 1</MemberNumber>
<MethodType>sample string 3</MethodType>
<TaxAmount>5</TaxAmount>
<TotalAdminFees>6</TotalAdminFees>
</InvoiceResponse>
</Data>
</MethodsGetResponse>
multipart/form-data
Sample:
<MethodsGetResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oracle_API.Models"><Httpcode>sample string 2</Httpcode><Httpstatus>sample string 3</Httpstatus><Message>sample string 4</Message><Success>true</Success><Data><InvoiceResponse><AdminFees>4</AdminFees><InvoiceNumber>sample string 2</InvoiceNumber><MemberNumber>sample string 1</MemberNumber><MethodType>sample string 3</MethodType><TaxAmount>5</TaxAmount><TotalAdminFees>6</TotalAdminFees></InvoiceResponse><InvoiceResponse><AdminFees>4</AdminFees><InvoiceNumber>sample string 2</InvoiceNumber><MemberNumber>sample string 1</MemberNumber><MethodType>sample string 3</MethodType><TaxAmount>5</TaxAmount><TotalAdminFees>6</TotalAdminFees></InvoiceResponse></Data></MethodsGetResponse>