POST api/document
Request Information
URI Parameters
None.
Body Parameters
Document| Name | Description | Type | Additional information |
|---|---|---|---|
| CardHolderAccountInfo | CardHolderAccountInformation |
None. |
|
| Id | string |
Max length: 2147483647 |
|
| InstID | globally unique identifier |
None. |
|
| Device | globally unique identifier |
None. |
|
| SetupId | string |
Max length: 2147483647 |
|
| Currency | string |
Max length: 2147483647 |
|
| Amount | decimal number |
None. |
|
| DocumentAmount | decimal number |
None. |
|
| TaxAmount | decimal number |
None. |
|
| TradeDiscount | decimal number |
None. |
|
| Freight | decimal number |
None. |
|
| MiscAmount | decimal number |
None. |
|
| CustomerNumber | string |
Max length: 2147483647 |
|
| CustomerName | string |
Max length: 2147483647 |
|
| IsMultipleInvoice | boolean |
None. |
|
| DocumentNumber | string |
Max length: 2147483647 |
|
| DocumentNumberDisplay | string |
Max length: 2147483647 |
|
| TransactionType | string |
Max length: 2147483647 |
|
| CreatedOn | date |
None. |
|
| ModifiedOn | date |
None. |
|
| DocDate | date |
None. |
|
| DueDate | date |
None. |
|
| DocType | integer |
None. |
|
| PaymentTerm | string |
Max length: 2147483647 |
|
| SourceOfDocument | integer |
None. |
|
| BatchSource | integer |
None. |
|
| BatchNo | string |
Max length: 2147483647 |
|
| MerchantEmail | string |
Max length: 2147483647 |
|
| ReturnUrl | string |
Max length: 2147483647 |
|
| Status | DocumentStatus |
None. |
|
| IntegrationStatus | IntegrationStatus |
None. |
|
| Tax | Tax |
None. |
|
| ShippingAddress | Address |
None. |
|
| BillingAddress | Address |
None. |
|
| Items | Collection of ItemEntry |
None. |
|
| UserDefinedFields | Collection of Field |
None. |
|
| Notification | DocumentNotification |
None. |
|
| PostDataType | string |
Max length: 2147483647 |
|
| TransactionKey | string |
Max length: 2147483647 |
|
| PaidOn | date |
None. |
|
| LastProcessDate | date |
None. |
|
| Message | string |
Max length: 2147483647 |
|
| CustomeMessage | string |
Max length: 2147483647 |
|
| Payment | PaymentOption |
None. |
|
| NotificationEmail | string |
Max length: 2147483647 |
|
| NotificationEmailDisplay | string |
Max length: 2147483647 |
|
| NotificationPhone | string |
Max length: 2147483647 |
|
| NotificationPhoneDisplay | string |
Max length: 2147483647 |
|
| OriginalTender | string |
Max length: 2147483647 |
|
| PayFabricTransactionData | PFTransaction |
None. |
|
| Link | string |
Max length: 2147483647 |
|
| EntryClass | string |
Max length: 2147483647 |
|
| CreatedOnUTC | date |
None. |
|
| ModifiedOnUTC | date |
None. |
|
| PaidOnUTC | date |
None. |
|
| LastProcessDateUTC | date |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
Document| Name | Description | Type | Additional information |
|---|---|---|---|
| CardHolderAccountInfo | CardHolderAccountInformation |
None. |
|
| Id | string |
Max length: 2147483647 |
|
| InstID | globally unique identifier |
None. |
|
| Device | globally unique identifier |
None. |
|
| SetupId | string |
Max length: 2147483647 |
|
| Currency | string |
Max length: 2147483647 |
|
| Amount | decimal number |
None. |
|
| DocumentAmount | decimal number |
None. |
|
| TaxAmount | decimal number |
None. |
|
| TradeDiscount | decimal number |
None. |
|
| Freight | decimal number |
None. |
|
| MiscAmount | decimal number |
None. |
|
| CustomerNumber | string |
Max length: 2147483647 |
|
| CustomerName | string |
Max length: 2147483647 |
|
| IsMultipleInvoice | boolean |
None. |
|
| DocumentNumber | string |
Max length: 2147483647 |
|
| DocumentNumberDisplay | string |
Max length: 2147483647 |
|
| TransactionType | string |
Max length: 2147483647 |
|
| CreatedOn | date |
None. |
|
| ModifiedOn | date |
None. |
|
| DocDate | date |
None. |
|
| DueDate | date |
None. |
|
| DocType | integer |
None. |
|
| PaymentTerm | string |
Max length: 2147483647 |
|
| SourceOfDocument | integer |
None. |
|
| BatchSource | integer |
None. |
|
| BatchNo | string |
Max length: 2147483647 |
|
| MerchantEmail | string |
Max length: 2147483647 |
|
| ReturnUrl | string |
Max length: 2147483647 |
|
| Status | DocumentStatus |
None. |
|
| IntegrationStatus | IntegrationStatus |
None. |
|
| Tax | Tax |
None. |
|
| ShippingAddress | Address |
None. |
|
| BillingAddress | Address |
None. |
|
| Items | Collection of ItemEntry |
None. |
|
| UserDefinedFields | Collection of Field |
None. |
|
| Notification | DocumentNotification |
None. |
|
| PostDataType | string |
Max length: 2147483647 |
|
| TransactionKey | string |
Max length: 2147483647 |
|
| PaidOn | date |
None. |
|
| LastProcessDate | date |
None. |
|
| Message | string |
Max length: 2147483647 |
|
| CustomeMessage | string |
Max length: 2147483647 |
|
| Payment | PaymentOption |
None. |
|
| NotificationEmail | string |
Max length: 2147483647 |
|
| NotificationEmailDisplay | string |
Max length: 2147483647 |
|
| NotificationPhone | string |
Max length: 2147483647 |
|
| NotificationPhoneDisplay | string |
Max length: 2147483647 |
|
| OriginalTender | string |
Max length: 2147483647 |
|
| PayFabricTransactionData | PFTransaction |
None. |
|
| Link | string |
Max length: 2147483647 |
|
| EntryClass | string |
Max length: 2147483647 |
|
| CreatedOnUTC | date |
None. |
|
| ModifiedOnUTC | date |
None. |
|
| PaidOnUTC | date |
None. |
|
| LastProcessDateUTC | date |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.
application/xml
Sample not available.
text/xml
Sample not available.