Developers
Gosocket Api Doc
Gosocket Api Endpoints
Production: http://api.gosocket.net/
Sandbox: http://api.sandbox.gosocket.net/
Gosocket Api Authentication
All Gosocket Api method call requiere Basic Authentication.
Username = {Application Id}
Password = {Token}
Gadget
API METHOD | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GET api/Gadget/GetUser Response Information
Response body formats
application/json, text/json
Sample:
{ "UserId": "8a79a17e-cca2-4435-a2ba-864a771259b7", "Name": "sample string 2", "Email": "sample string 3", "Code": "sample string 4", "ImageUrl": "sample string 5", "CurrentCountryId": "sample string 6", "CurrentTimeZoneId": "sample string 7", "CurrentAccountId": "f03658d8-4059-429b-bb2e-a8ef139ca8ea", "CurrentAccountCode": "sample string 8", "CurrentAccountName": "sample string 9", "Token": "sample string 10" } |
Get current user |
|||||||||||||||||||||||||||
GET api/Gadget/GetAcl Response Information
Response body formats
application/json, text/json
Sample:
[ { "UserId": "2e030e56-975d-4ca0-b5d1-92dd564da143", "ApplicationAlias": "sample string 2", "Permission": "sample string 3" }, { "UserId": "2e030e56-975d-4ca0-b5d1-92dd564da143", "ApplicationAlias": "sample string 2", "Permission": "sample string 3" }, { "UserId": "2e030e56-975d-4ca0-b5d1-92dd564da143", "ApplicationAlias": "sample string 2", "Permission": "sample string 3" } ] |
Get user acl (Access Control List) |
|||||||||||||||||||||||||||
GET api/Gadget/GetMyAccounts Response Information
Response body formats
application/json, text/json
Sample:
[ { "AccountId": "bda98993-e8b9-41d5-98da-486ed8d04802", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "bda98993-e8b9-41d5-98da-486ed8d04802", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "bda98993-e8b9-41d5-98da-486ed8d04802", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } ] |
Get all assigned Accounts in Gosocket for current user |
|||||||||||||||||||||||||||
GET api/Gadget/GetAccount?code={code} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
{ "AccountId": "00d7d6b2-c395-4c66-845e-c6417f38cbd2", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } |
Get information about specified account |
|||||||||||||||||||||||||||
GET api/Gadget/GetAccount?accountId={accountId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
{ "AccountId": "ec144d68-e03a-4956-abc0-3103848c0425", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } |
Get information about specified account |
|||||||||||||||||||||||||||
GET api/Gadget/GetClients?MyAccountId={MyAccountId}&Page={Page} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "AccountId": "a33034d9-94dd-4d06-ac24-6fb1645b9809", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "a33034d9-94dd-4d06-ac24-6fb1645b9809", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "a33034d9-94dd-4d06-ac24-6fb1645b9809", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } ] |
Get client list from specified account |
|||||||||||||||||||||||||||
GET api/Gadget/GetVendors?MyAccountId={MyAccountId}&Page={Page} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "AccountId": "ea7219a2-91c4-4e56-bd55-c5fd805de41c", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "ea7219a2-91c4-4e56-bd55-c5fd805de41c", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "ea7219a2-91c4-4e56-bd55-c5fd805de41c", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } ] |
Get vendor list for specified account |
|||||||||||||||||||||||||||
GET api/Gadget/GetVendors?accountId={accountId}&page={page}&elementsByPage={elementsByPage}&vendorCode={vendorCode} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "AccountId": "06a30385-3965-4c49-985f-23b051fa8a02", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "06a30385-3965-4c49-985f-23b051fa8a02", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" }, { "AccountId": "06a30385-3965-4c49-985f-23b051fa8a02", "Name": "sample string 2", "Code": "sample string 3", "Address": "sample string 4", "City": "sample string 5", "Province": "sample string 6", "Phone": "sample string 7", "Fax": "sample string 8", "ContactEmail": "sample string 9", "ImageUrl": "sample string 10", "GroupName": "sample string 11" } ] |
Get vendor list for specified account |
|||||||||||||||||||||||||||
GET api/Gadget/CountVendors?accountId={accountId}&vendorCode={vendorCode} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
1 |
Get vendor count by specified account id and vendor code |
|||||||||||||||||||||||||||
GET api/Gadget/GetDocumentTypes Response Information
Response body formats
application/json, text/json
Sample:
[ { "DocumentTypeId": 1, "Code": "sample string 2", "Description": "sample string 3", "Class": 64 }, { "DocumentTypeId": 1, "Code": "sample string 2", "Description": "sample string 3", "Class": 64 }, { "DocumentTypeId": 1, "Code": "sample string 2", "Description": "sample string 3", "Class": 64 } ] |
Get document type list for selected Gosocket account |
|||||||||||||||||||||||||||
GET api/Gadget/GetSentDocumentsByPO?MyAccountId={MyAccountId}&PO={PO}&Page={Page} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "DocumentId": "643a1989-1907-460b-b11e-36f12bed6e06", "SenderId": "9460a505-1dc6-41c9-8e6c-000e94acf1e0", "ReceiverId": "64d30bc1-2a30-4c78-87bf-10fb63077afd", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:03:47.0943332+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "643a1989-1907-460b-b11e-36f12bed6e06", "SenderId": "9460a505-1dc6-41c9-8e6c-000e94acf1e0", "ReceiverId": "64d30bc1-2a30-4c78-87bf-10fb63077afd", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:03:47.0943332+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "643a1989-1907-460b-b11e-36f12bed6e06", "SenderId": "9460a505-1dc6-41c9-8e6c-000e94acf1e0", "ReceiverId": "64d30bc1-2a30-4c78-87bf-10fb63077afd", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:03:47.0943332+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } ] |
Get sent purchased order for specified account |
|||||||||||||||||||||||||||
GET api/Gadget/GetSentDocuments?MyAccountId={MyAccountId}&fromDate={fromDate}&toDate={toDate}&DocumentTypeId={DocumentTypeId}&ReceiverCode={ReceiverCode}&Number={Number}&Page={Page}&ReadMode={ReadMode} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } ] |
Get sent document list |
|||||||||||||||||||||||||||
GET api/Gadget/GetSentDocuments?accountId={accountId}&ReceiverCode={ReceiverCode}&Number={Number}&DateFrom={DateFrom}&DateTo={DateTo}&Count={Count} Request InformationParameters
Request body formatsapplication/json, text/json
Sample:
[ { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "a2f722bd-261b-4329-abdf-3ef421f70822", "SenderId": "b38a5a4c-aea5-4ac6-9991-d1c805665207", "ReceiverId": "4d9c1cc2-8b3d-495d-ac8f-b76f14ce22d7", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:04:27.1292923+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } ] |
Get sent document list |
|||||||||||||||||||||||||||
GET api/Gadget/GetSentDocuments?accountId={accountId}&fromDate={fromDate}&toDate={toDate}&documentTypesId={documentTypesId}&numbers={numbers} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "DocumentId": "8cd251d2-afd5-40ff-9d9f-ad13700cbce8", "SenderId": "568dfca9-1081-4d2f-ae65-30b32c420f6a", "ReceiverId": "d616c927-c8c8-4de3-937c-a0f7a6e8e9d1", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:08:32.0373274+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "8cd251d2-afd5-40ff-9d9f-ad13700cbce8", "SenderId": "568dfca9-1081-4d2f-ae65-30b32c420f6a", "ReceiverId": "d616c927-c8c8-4de3-937c-a0f7a6e8e9d1", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:08:32.0373274+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "8cd251d2-afd5-40ff-9d9f-ad13700cbce8", "SenderId": "568dfca9-1081-4d2f-ae65-30b32c420f6a", "ReceiverId": "d616c927-c8c8-4de3-937c-a0f7a6e8e9d1", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:08:32.0373274+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } ] |
Get sent document list |
|||||||||||||||||||||||||||
GET api/Gadget/GetSentDocument?documentId={documentId}&senderAccountId={senderAccountId}&date={date} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
{ "DocumentId": "6b307140-b0d3-4c34-8739-85c1a26a0948", "SenderId": "a9ce8982-cb43-424b-8c7f-1a3cd7838017", "ReceiverId": "26611f03-071c-4919-8fc6-314f1fd11245", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:09:24.151087+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } |
Get sent document |
|||||||||||||||||||||||||||
GET api/Gadget/GetReceivedDocuments?MyAccountId={MyAccountId}&FromDate={FromDate}&ToDate={ToDate}&DocumentTypeId={DocumentTypeId}&SenderCode={SenderCode}&Number={Number}&Page={Page}&ReadMode={ReadMode} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "DocumentId": "09ad19dd-15cb-4da9-9d9b-932c6ce17e60", "SenderId": "4d5c4b66-5600-4318-adb1-921c8135bc6d", "ReceiverId": "08122cae-0b0f-451a-96ab-cef1e57afeac", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:10:04.0526105+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "09ad19dd-15cb-4da9-9d9b-932c6ce17e60", "SenderId": "4d5c4b66-5600-4318-adb1-921c8135bc6d", "ReceiverId": "08122cae-0b0f-451a-96ab-cef1e57afeac", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:10:04.0526105+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" }, { "DocumentId": "09ad19dd-15cb-4da9-9d9b-932c6ce17e60", "SenderId": "4d5c4b66-5600-4318-adb1-921c8135bc6d", "ReceiverId": "08122cae-0b0f-451a-96ab-cef1e57afeac", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "Number": 6, "Series": "sample string 7", "SenderCode": "sample string 8", "SenderName": "sample string 9", "ReceiverCode": "sample string 10", "ReceiverName": "sample string 11", "Date": "2015-01-26T14:10:04.0526105+00:00", "NetAmount": 13.0, "TaxAmount": 14.0, "FreeAmount": 15.0, "TotalAmount": 16.0, "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 17" } ] |
Get received document list |
|||||||||||||||||||||||||||
GET api/Gadget/GetXml?DocumentId={DocumentId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
"QEBA" |
Get base64 xml for specified document |
|||||||||||||||||||||||||||
GET api/Gadget/GetDistributionRules?AccountId={AccountId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[
{
"DistributionRuleId": "9f1aa860-b4f2-4959-995e-9226e70836e4",
"SenderId": "831af79f-314d-4c34-a1ad-20fde39ff1cb",
"ReceiverId": "509e780e-2e7f-4e93-b649-8b403ee0bd6e",
"Email": "sample string 3",
"Timestamp": "2015-01-26T14:12:16.2426737+00:00",
"Account": {
"k__BackingField": "773dfc92-a003-4a55-9fc2-25c96733a662",
"k__BackingField": "sample string 2",
"
k__BackingField»: «sample string 5», «k__BackingField»: «sample string 6», «k__BackingField»: «sample string 7», «k__BackingField»: «sample string 8», «k__BackingField»: «sample string 9», «k__BackingField»: «sample string 10», «k__BackingField»: «2015-01-26T14:12:16.2426737+00:00», «k__BackingField»: «cae70201-3f30-43c6-9880-ac690f52e28f», «k__BackingField»: «sample string 12», «k__BackingField»: { «k__BackingField»: «df205e83-19f8-4f31-93aa-2fea0510ea22», «k__BackingField»: «sample string 2» }, «k__BackingField»: true, «k__BackingField»: «sample string 14» } }, { «DistributionRuleId»: «9f1aa860-b4f2-4959-995e-9226e70836e4», «SenderId»: «831af79f-314d-4c34-a1ad-20fde39ff1cb», «ReceiverId»: «509e780e-2e7f-4e93-b649-8b403ee0bd6e», «Email»: «sample string 3», «Timestamp»: «2015-01-26T14:12:16.2426737+00:00», «Account»: { «k__BackingField»: «773dfc92-a003-4a55-9fc2-25c96733a662», «k__BackingField»: «sample string 2», «
k__BackingField»: «sample string 5», «k__BackingField»: «sample string 6», «k__BackingField»: «sample string 7», «k__BackingField»: «sample string 8», «k__BackingField»: «sample string 9», «k__BackingField»: «sample string 10», «k__BackingField»: «2015-01-26T14:12:16.2426737+00:00», «k__BackingField»: «cae70201-3f30-43c6-9880-ac690f52e28f», «k__BackingField»: «sample string 12», «k__BackingField»: { «k__BackingField»: «df205e83-19f8-4f31-93aa-2fea0510ea22», «k__BackingField»: «sample string 2» }, «k__BackingField»: true, «k__BackingField»: «sample string 14» } }, { «DistributionRuleId»: «9f1aa860-b4f2-4959-995e-9226e70836e4», «SenderId»: «831af79f-314d-4c34-a1ad-20fde39ff1cb», «ReceiverId»: «509e780e-2e7f-4e93-b649-8b403ee0bd6e», «Email»: «sample string 3», «Timestamp»: «2015-01-26T14:12:16.2426737+00:00», «Account»: { «k__BackingField»: «773dfc92-a003-4a55-9fc2-25c96733a662», «k__BackingField»: «sample string 2», «
k__BackingField»: «sample string 5», «k__BackingField»: «sample string 6», «k__BackingField»: «sample string 7», «k__BackingField»: «sample string 8», «k__BackingField»: «sample string 9», «k__BackingField»: «sample string 10», «k__BackingField»: «2015-01-26T14:12:16.2426737+00:00», «k__BackingField»: «cae70201-3f30-43c6-9880-ac690f52e28f», «k__BackingField»: «sample string 12», «k__BackingField»: { «k__BackingField»: «df205e83-19f8-4f31-93aa-2fea0510ea22», «k__BackingField»: «sample string 2» }, «k__BackingField»: true, «k__BackingField»: «sample string 14» } } ]
|
Get distribution rule for specified account. |
|||||||||||||||||||||||||||
GET api/Gadget/GetDocumentAttachments?CountryId={CountryId}&DocumentId={DocumentId}&Date={Date}&Sent={Sent} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "AttachmentId": "041fe557-c0a6-4161-9b68-39462d842329", "DocumentId": "4a03e63e-f2f2-41fa-a9a5-cc6427455475", "AttachmentTypeId": 3, "AttachmentTypeName": "sample string 4", "Name": "sample string 5", "Description": "sample string 6", "Date": "2015-01-26T14:13:11.5884772+00:00", "FileExt": "sample string 8", "ShowSender": true, "ShowReceiver": true, "RefSenderCode": "sample string 11", "RefDocumentTypeId": 12, "RefNumber": 13, "RefSeries": "sample string 14", "RefDate": "2015-01-26T14:13:11.5884772+00:00", "StatusCode": "sample string 16", "StatusDescription": "sample string 17", "Document": { "DocumentId": "050bbc2e-fc7c-4680-92eb-15be66608e9f", "SenderId": "b176a920-9fbc-4ae3-8d7a-efd24f34ac7e", "ReceiverId": "ea6f698b-a8e4-43cc-b807-d8f402940aa2", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 6", "Number": 7, "Series": "sample string 8", "SenderCode": "sample string 9", "SenderName": "sample string 10", "ReceiverCode": "sample string 11", "ReceiverName": "sample string 12", "Date": "2015-01-26T14:13:11.6041003+00:00", "NetAmount": 14.0, "TaxAmount": 15.0, "FreeAmount": 16.0, "TotalAmount": 17.0, "DateNumber": 18, "Timestamp": "2015-01-26T14:13:11.6041003+00:00" } }, { "AttachmentId": "041fe557-c0a6-4161-9b68-39462d842329", "DocumentId": "4a03e63e-f2f2-41fa-a9a5-cc6427455475", "AttachmentTypeId": 3, "AttachmentTypeName": "sample string 4", "Name": "sample string 5", "Description": "sample string 6", "Date": "2015-01-26T14:13:11.5884772+00:00", "FileExt": "sample string 8", "ShowSender": true, "ShowReceiver": true, "RefSenderCode": "sample string 11", "RefDocumentTypeId": 12, "RefNumber": 13, "RefSeries": "sample string 14", "RefDate": "2015-01-26T14:13:11.5884772+00:00", "StatusCode": "sample string 16", "StatusDescription": "sample string 17", "Document": { "DocumentId": "050bbc2e-fc7c-4680-92eb-15be66608e9f", "SenderId": "b176a920-9fbc-4ae3-8d7a-efd24f34ac7e", "ReceiverId": "ea6f698b-a8e4-43cc-b807-d8f402940aa2", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 6", "Number": 7, "Series": "sample string 8", "SenderCode": "sample string 9", "SenderName": "sample string 10", "ReceiverCode": "sample string 11", "ReceiverName": "sample string 12", "Date": "2015-01-26T14:13:11.6041003+00:00", "NetAmount": 14.0, "TaxAmount": 15.0, "FreeAmount": 16.0, "TotalAmount": 17.0, "DateNumber": 18, "Timestamp": "2015-01-26T14:13:11.6041003+00:00" } }, { "AttachmentId": "041fe557-c0a6-4161-9b68-39462d842329", "DocumentId": "4a03e63e-f2f2-41fa-a9a5-cc6427455475", "AttachmentTypeId": 3, "AttachmentTypeName": "sample string 4", "Name": "sample string 5", "Description": "sample string 6", "Date": "2015-01-26T14:13:11.5884772+00:00", "FileExt": "sample string 8", "ShowSender": true, "ShowReceiver": true, "RefSenderCode": "sample string 11", "RefDocumentTypeId": 12, "RefNumber": 13, "RefSeries": "sample string 14", "RefDate": "2015-01-26T14:13:11.5884772+00:00", "StatusCode": "sample string 16", "StatusDescription": "sample string 17", "Document": { "DocumentId": "050bbc2e-fc7c-4680-92eb-15be66608e9f", "SenderId": "b176a920-9fbc-4ae3-8d7a-efd24f34ac7e", "ReceiverId": "ea6f698b-a8e4-43cc-b807-d8f402940aa2", "DocumentTypeId": 4, "DocumentTypeName": "sample string 5", "CurrencyTypeId": 1, "CurrencyTypeName": "sample string 6", "Number": 7, "Series": "sample string 8", "SenderCode": "sample string 9", "SenderName": "sample string 10", "ReceiverCode": "sample string 11", "ReceiverName": "sample string 12", "Date": "2015-01-26T14:13:11.6041003+00:00", "NetAmount": 14.0, "TaxAmount": 15.0, "FreeAmount": 16.0, "TotalAmount": 17.0, "DateNumber": 18, "Timestamp": "2015-01-26T14:13:11.6041003+00:00" } } ] |
Get attachment list for specified document. |
|||||||||||||||||||||||||||
GET api/Gadget/GetAttachment?CountryId={CountryId}&AttachmentId={AttachmentId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
"QEBA" |
Get base64 attachment for specified attachment id |
|||||||||||||||||||||||||||
GET api/Gadget/GetUserAndContactsForVendor?vendorAccountId={vendorAccountId}&searchWord={searchWord} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
[ { "Email": "sample string 1", "Name": "sample string 2" }, { "Email": "sample string 1", "Name": "sample string 2" }, { "Email": "sample string 1", "Name": "sample string 2" } ] |
Get contact list for specified vendor |
|||||||||||||||||||||||||||
POST api/Gadget/SetDocumentOwner?documentId={documentId}&documentDate={documentDate}&accountId={accountId}&reason={reason}&creationSource={creationSource}&denied={denied} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
true |
Set owner for specified document |
|||||||||||||||||||||||||||
GET api/Gadget/ExistAttachment?documentId={documentId}&documentDate={documentDate}&attachmentTypeId={attachmentTypeId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
true |
Verify if attachment exist |
|||||||||||||||||||||||||||
GET api/Gadget/GetExpireDate?documentId={documentId} Request InformationParameters
Response Information
Response body formats
application/json, text/json
Sample:
"2015-01-26T14:15:35.0804865+00:00" |
Get expiration date for specified document |
Responder