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:

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Request (JSON):

Sample Response (JSON):

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:

Sample Request (JSON):

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Response (JSON):

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[]

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:

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Request (JSON):

Sample Response (JSON):

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:

Sample Request (JSON):

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Response (JSON):

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:

Sample Response (JSON):

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[]