Accounting (In Development)
The accounting services below provide the ability to manage receivables function within Quipt. The provided services can be used to retrieve open or historical transactions, view payments, and apply new payments. Click here for a few use cases using the accounting services.
Get Transactions
This services allows a partner to retrieve a paged list of receivable transactions.
URLhttps://api.getquipt.com/v2/accounting/receivables/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &partnerId | A comma separated list of partners to include.. | String | No |
| &ids | A comma separated list of Quipt identifiers. | String | No |
| &status | A comma separated list of statuses, (0 = Incomplete, 1 = ActionRequired, 4 = Open, 16 = FundInitiated, 64 = FundsSubmitted, 256 = FundsConfirmed, 1024 = Settled). | String | No |
| &types | A comma separated list of types, (0 = Order, 2 = Return, 8 = Credit, 32 = Debit). | String | No |
| &include | A comma separated list of properties to include. Option includes 'Payments'. | String | No |
| &unacknowledged | Whether or not to filter out unacknowledged transactions. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/accounting/receivables/100/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
{ "Paging": { "PageNumber": 1, "Total": 1, "HasMoreRecords": true }, "Result": [ { "Payments": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Name": "RetailerName" }, "PaymentNumber": null, "PaymentAt": "2015-08-05T21:11:12.547", "Total": { "Value": 166.7900, "Units": 0 } } ], "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Type": 2, "Status": 0, "SubStatus": 0, "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Name": "RetailerName" }, "DueAt": "2015-08-08T00:00:00", "SettledAt": null, "Total": { "Value": 166.7900, "Units": 0 }, "Balance": { "Value": 166.7900, "Units": 0 } } ], "TransactionId": null, "TransactionTime": "2017-01-07T00:41:25.0952508Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of ledger results. | LedgerResult[] |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Transaction By Id
This service allows a partner to retrieve a specific receivable item by the Quipt identifier.
URLhttps://api.getquipt.com/v2/accounting/receivables/id/{id}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {id} | The Quipt identifier. | String | No |
| &include | A comma separated list of properties to include. Option includes 'Payments'. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/accounting/receivables/id/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
{ "Payments": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Name": "RetailerName" }, "PaymentNumber": null, "PaymentAt": "2014-06-22T01:41:13.223", "Total": { "Value": 29.0000, "Units": 0 } } ], "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Type": 2, "Status": 0, "SubStatus": 0, "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": null, "Name": "RetailerName" }, "DueAt": "2014-06-26T00:00:00", "SettledAt": null, "Total": { "Value": 29.0000, "Units": 0 }, "Balance": { "Value": 29.0000, "Units": 0 } } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The ledger result. | LedgerResult |
Acknowledge
This service allows a partner to acknowledge a receivable transaction.
URLhttps://api.getquipt.com/v2/accounting/receivables/acknowledge
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| Acknowledgements | The collection of acknowledgements. | Ledger.Acknowledgement[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/accounting/receivables/acknowledge Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
{ "Acknowledgements": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Partner": { "Code": null, "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name": null }, "Type": 2, "TransactionNumber": null } ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived": 1, "TransactionId": null, "TransactionTime": "2017-01-09T16:47:25.5988461Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Payment
This service allows a partner to create and apply a payment.
URLhttps://api.getquipt.com/v2/accounting/receivables/payments/apply
Methodpost
Body Definitions:
| Name | Description | Type | Required |
|---|---|---|---|
| Payments | The payments to apply. | Payment[] | Yes |
| TransactionId | The transaction id for the request. | String | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/accounting/receivables/payments/apply Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
{ "Payments" : [{ "PaymentNumber": "PaymentNumber01", "AutoApply": true, "Partner": { "Code": "RetailerCode", "Id": null, "Name": null }, "PaymentMethod": { "Id": null, "Code": "CC", "Name": null }, "Amount": { "Value": 10.0, "Units": 0 }, "ApplyTo": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Amount": { "Value": 210.0, "Units": 0 }, "Type": 2, "TransactionNumber": null } ]} ], "TransactionId": null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived" : 1, "TransactionId" : null, "TransactionTime" : "2015-12-28T17:51:12.1518881Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Payments
This service allows a partner to retrieve a paged list of payments.
URLhttps://api.getquipt.com/v2/accounting/receivables/payments/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &partnerId | A comma separated list of partners to include. | String | No |
| &ids | A comma separated list of Quipt identifiers. | String | No |
| &status | A comma separated list of statuses, (0 = Incomplete, 1 = ActionRequired, 4 = Open, 8 = Completed, 16 = Canceled). | String | No |
| &include | A comma separated list of properties to include. Options include 'Details' and 'Items'. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/accounting/receivables/payments/100/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
{ "Paging": { "PageNumber": 1, "Total": 1, "HasMoreRecords": true }, "Result": [ { "Items": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Type": 2, "Status": 0, "SubStatus": 0, "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": "RetailerCode", "Name": "RetailerName" }, "DueAt": "2014-04-22T00:00:00", "SettledAt": null, "Total": { "Value": 239.0000, "Units": 0 }, "Balance": { "Value": 239.0000, "Units": 0 } } ], "Details": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CreatedAt": "2014-04-14T06:41:51.32", "Total": { "Value": 239.0000, "Units": 0 }, "Type": 20, "Status": 10 }, { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CreatedAt": "2014-04-10T19:07:04.763", "Total": { "Value": 239.0000, "Units": 0 }, "Type": 10, "Status": 10 } ], "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": "RetailerCode", "Name": "RetailerName" }, "PaymentNumber": null, "PaymentAt": "2014-04-10T18:49:07.863", "Total": { "Value": 239.0000, "Units": 0 } } ], "TransactionId": null, "TransactionTime": "2017-01-07T00:41:38.5869254Z", "Success": true, "Messages": [ ] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Paging | Paging information for the records returned. | Paging |
| Result | The collection of inventory results. | PaymentResult[] |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Payment by Id
This service allows a partner to retrieve a specific payment by identifier.
URLhttps://api.getquipt.com/v2/accounting/receivables/payments/id/{Id}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {id} | The Quipt identifier. | Guid | Yes |
| &include | A comma separated list of properties to include. Options include 'Details' and 'Items'. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/accounting/receivables/payments/id/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
{ "Items": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Type": 2, "Status": 0, "SubStatus": 0, "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": "RetailerCode", "Name": "RetailerName" }, "DueAt": "2014-04-22T00:00:00", "SettledAt": null, "Total": { "Value": 239.0000, "Units": 0 }, "Balance": { "Value": 239.0000, "Units": 0 } } ], "Details": [ { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CreatedAt": "2014-04-14T06:41:51.32", "Total": { "Value": 239.0000, "Units": 0 }, "Type": 20, "Status": 10 }, { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CreatedAt": "2014-04-10T19:07:04.763", "Total": { "Value": 239.0000, "Units": 0 }, "Type": 10, "Status": 10 } ], "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Partner": { "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code": "RetailerCode", "Name": "RetailerName" }, "PaymentNumber": null, "PaymentAt": "2014-04-10T18:49:07.863", "Total": { "Value": 239.0000, "Units": 0 } } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| The payment result. | PaymentResult |
Batch Report
This service allows a partner to retrieve the detailed report generated when the ‘Acknowledgement’ or ‘Apply’ service is used. The result of each service returns the {id} used to retrieve the report using this service.
URLhttps://api.getquipt.com/v2/accounting/receivables/report/{id}/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| {id} | The report identifier. | Guid | Yes |
| &includeLines | Flag whether or not to include the line details. | Boolean | No |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/accounting/receivables/report/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/100/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
{ "Result" : [ { "RecordId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordKey" : "Key", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 64, "Message" : "", "Record" : 1 } ], "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReportTime" : "2014-07-26T05:57:03.667", "ReportStatus" : 64, "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "TransactionId" : null, "TransactionTime" : "2015-12-28T21:28:40.535376Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of ledger report items. | LedgerReport[] |
| ReportId | The report id. | Guid |
| ReportTime | The time the report was generated. | DateTime |
| ReportStatus | The current status of the report. | Int |
| Paging | Paging information for the records returned. | Paging |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |