GET api/ProformaInvoice/GetProformaInvoiceStatus?ProformaInvoiceYear={ProformaInvoiceYear}&ProformaInvoiceBook={ProformaInvoiceBook}&ProformaInvoiceNumber={ProformaInvoiceNumber}&IncludeClosedDocuments={IncludeClosedDocuments}&RequestType={RequestType}&Page={Page}&PageSize={PageSize}&RecordDtModifiedFrom={RecordDtModifiedFrom}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
ProformaInvoiceYear | integer |
None. |
|
ProformaInvoiceBook | string |
Required |
|
ProformaInvoiceNumber | integer |
None. |
|
IncludeClosedDocuments | boolean |
None. |
|
RequestType | sqRequestType |
None. |
|
Page | integer |
None. |
|
PageSize | integer |
None. |
|
RecordDtModifiedFrom | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ProformaInvoiceStatusName | Description | Type | Additional information |
---|---|---|---|
ProformaInvoiceYear | integer |
None. |
|
ProformaInvoiceBook | string |
None. |
|
ProformaInvoiceNumber | integer |
None. |
|
ProformaInvoiceID | string |
None. |
|
Status | string |
None. |
|
StatusDescription | string |
None. |
|
ProcessStatus | string |
None. |
|
ProcessStatusDescription | string |
None. |
|
DocumentState | integer |
None. |
|
DocumentStateDescription | string |
None. |
|
Approval | integer |
None. |
|
ApprovalDescription | string |
None. |
|
CustomerID | string |
None. |
|
CustomerPayerID | string |
None. |
|
InvoiceDate | date |
None. |
|
DeliveryDateFrom | date |
None. |
|
DeliveryDateTo | date |
None. |
|
DueDate | date |
None. |
|
InsertedBy | string |
None. |
|
InsertedTime | date |
None. |
|
ModifiedBy | string |
None. |
|
ModifiedTime | date |
None. |
|
OpenAmount | decimal number |
None. |
|
ClosedAmount | decimal number |
None. |
|
ClosedAmountWithBS | decimal number |
None. |
|
OpenAmountLC | decimal number |
None. |
|
ClosedAmountLC | decimal number |
None. |
|
ClosedAmountLCWithBS | decimal number |
None. |
|
PaymentDate | date |
None. |
|
ClosedAmountTotal | decimal number |
None. |
|
ClosedAmountLCTotal | decimal number |
None. |
Response Formats
application/xml, text/xml
Sample:
<ArrayOfProformaInvoiceStatus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <ProformaInvoiceStatus> <ProformaInvoiceYear>1</ProformaInvoiceYear> <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook> <ProformaInvoiceNumber>3</ProformaInvoiceNumber> <ProformaInvoiceID>sample string 4</ProformaInvoiceID> <Status>sample string 5</Status> <StatusDescription>sample string 6</StatusDescription> <ProcessStatus>sample string 7</ProcessStatus> <ProcessStatusDescription>sample string 8</ProcessStatusDescription> <DocumentState>9</DocumentState> <DocumentStateDescription>sample string 10</DocumentStateDescription> <Approval>11</Approval> <ApprovalDescription>sample string 12</ApprovalDescription> <CustomerID>sample string 13</CustomerID> <CustomerPayerID>sample string 14</CustomerPayerID> <InvoiceDate>2024-03-29T15:39:13.5562497+01:00</InvoiceDate> <DeliveryDateFrom>2024-03-29T15:39:13.5562497+01:00</DeliveryDateFrom> <DeliveryDateTo>2024-03-29T15:39:13.5562497+01:00</DeliveryDateTo> <DueDate>2024-03-29T15:39:13.5562497+01:00</DueDate> <InsertedBy>sample string 15</InsertedBy> <InsertedTime>2024-03-29T15:39:13.5562497+01:00</InsertedTime> <ModifiedBy>sample string 16</ModifiedBy> <ModifiedTime>2024-03-29T15:39:13.5572497+01:00</ModifiedTime> <OpenAmount>1</OpenAmount> <ClosedAmount>1</ClosedAmount> <ClosedAmountWithBS>1</ClosedAmountWithBS> <OpenAmountLC>1</OpenAmountLC> <ClosedAmountLC>1</ClosedAmountLC> <ClosedAmountLCWithBS>1</ClosedAmountLCWithBS> <PaymentDate>2024-03-29T15:39:13.5572497+01:00</PaymentDate> <ClosedAmountTotal>1</ClosedAmountTotal> <ClosedAmountLCTotal>1</ClosedAmountLCTotal> </ProformaInvoiceStatus> <ProformaInvoiceStatus> <ProformaInvoiceYear>1</ProformaInvoiceYear> <ProformaInvoiceBook>sample string 2</ProformaInvoiceBook> <ProformaInvoiceNumber>3</ProformaInvoiceNumber> <ProformaInvoiceID>sample string 4</ProformaInvoiceID> <Status>sample string 5</Status> <StatusDescription>sample string 6</StatusDescription> <ProcessStatus>sample string 7</ProcessStatus> <ProcessStatusDescription>sample string 8</ProcessStatusDescription> <DocumentState>9</DocumentState> <DocumentStateDescription>sample string 10</DocumentStateDescription> <Approval>11</Approval> <ApprovalDescription>sample string 12</ApprovalDescription> <CustomerID>sample string 13</CustomerID> <CustomerPayerID>sample string 14</CustomerPayerID> <InvoiceDate>2024-03-29T15:39:13.5562497+01:00</InvoiceDate> <DeliveryDateFrom>2024-03-29T15:39:13.5562497+01:00</DeliveryDateFrom> <DeliveryDateTo>2024-03-29T15:39:13.5562497+01:00</DeliveryDateTo> <DueDate>2024-03-29T15:39:13.5562497+01:00</DueDate> <InsertedBy>sample string 15</InsertedBy> <InsertedTime>2024-03-29T15:39:13.5562497+01:00</InsertedTime> <ModifiedBy>sample string 16</ModifiedBy> <ModifiedTime>2024-03-29T15:39:13.5572497+01:00</ModifiedTime> <OpenAmount>1</OpenAmount> <ClosedAmount>1</ClosedAmount> <ClosedAmountWithBS>1</ClosedAmountWithBS> <OpenAmountLC>1</OpenAmountLC> <ClosedAmountLC>1</ClosedAmountLC> <ClosedAmountLCWithBS>1</ClosedAmountLCWithBS> <PaymentDate>2024-03-29T15:39:13.5572497+01:00</PaymentDate> <ClosedAmountTotal>1</ClosedAmountTotal> <ClosedAmountLCTotal>1</ClosedAmountLCTotal> </ProformaInvoiceStatus> </ArrayOfProformaInvoiceStatus>