logo

Invoices

Creates a new invoice.

SecurityBearer or Bearer or Bearer or Bearer
Request
header Parameters
x-api-version
string
Request Body schema: application/json

The invoice creation request.

dueDate
string or null
cardPaymentProcessorId
string or null <uuid>
achPaymentProcessorId
string or null <uuid>
additionalNotes
string or null
shippingAmount
number or null <double>
taxPercentage
number or null <double>
feesPercentage
number or null <double>
discountPercentage
number or null <double>
merchantContactInfoId
string or null <uuid>
customerId
string or null <uuid>
achAllowFasterProcessing
boolean or null
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto)
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto)
canPriceBeForceOverrided
boolean
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/pay-int-api/invoices
Request samples
application/json
{
  • "dueDate": "string",
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "additionalNotes": "string",
  • "shippingAmount": 0,
  • "taxPercentage": 0,
  • "feesPercentage": 0,
  • "discountPercentage": 0,
  • "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "achAllowFasterProcessing": true,
  • "customer": {
    },
  • "lineItems": [
    ],
  • "canPriceBeForceOverrided": true
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Retrieves a paginated list of invoices.

SecurityBearer or Bearer or Bearer or Bearer
Request
query Parameters
issueDateFrom
string <date-time>
issueDateTo
string <date-time>
dueDateFrom
string <date-time>
dueDateTo
string <date-time>
paymentDateFrom
string <date-time>
paymentDateTo
string <date-time>
status
integer <int32> (PaymentIntegrations.Contracts.Enums.InvoiceStatus)

Possible values:

  • 1 - Draft:
  • 2 - Published:
  • 3 - Paid:
  • 4 - Expired:
  • 5 - Canceled:
  • 6 - ProcessingPayment:
  • 7 - Refunded:
Enum: 1 2 3 4 5 6 7
page
integer <int32>
pageSize
integer <int32>
orderBy
string
asc
boolean
search
string
header Parameters
x-api-version
string
Responses
200

OK

get/pay-int-api/invoices
Request samples 
Response samples 
application/json
{
  • "items": [
    ],
  • "total": 0
}
Retrieves details of a specific invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice to retrieve.


 
header Parameters
x-api-version
string
 
Responses 
200
OK


404
Not Found


get/pay-int-api/invoices/{invoiceId}
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "number": "string",
  • "status": 1,
  • "issueDate": "2019-08-24T14:15:22Z",
  • "dueDate": "2019-08-24T14:15:22Z",
  • "paymentDate": "2019-08-24T14:15:22Z",
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "additionalNotes": "string",
  • "subTotalAmount": 0,
  • "shippingAmount": 0,
  • "totalAmount": 0,
  • "taxPercentage": 0,
  • "feesPercentage": 0,
  • "discountPercentage": 0,
  • "surchargePercentage": 0,
  • "surchargeAmount": 0,
  • "cashDiscountPercentage": 0,
  • "cashDiscountAmount": 0,
  • "paymentMethodTypeId": 0,
  • "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
  • "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
  • "merchantContactInfo": {
    },
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "customer": {
    },
  • "lineItems": [
    ],
  • "isCustomerUpdated": true,
  • "isLineItemsUpdated": true,
  • "fullUrl": "string",
  • "shortUrl": "string",
  • "markedAsPaid": true,
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "achAllowFasterProcessing": true,
  • "history": [
    ],
  • "zeroCostProcessingOptionId": 0,
  • "zeroCostProcessingOption": "string",
  • "useCardPrice": true,
  • "invoiceCalculations": {
    }
}
Updates a specific invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice to update.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The invoice update request.


dueDate
string or null
 
cardPaymentProcessorId
string or null <uuid> 
 
achPaymentProcessorId
string or null <uuid> 
 
additionalNotes
string or null
 
shippingAmount
number or null <double> 
 
taxPercentage
number or null <double> 
 
feesPercentage
number or null <double> 
 
discountPercentage
number or null <double> 
 
merchantContactInfoId
string or null <uuid> 
 
customerId
string or null <uuid> 
 
achAllowFasterProcessing
boolean or null
 
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) 
 
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) 
 
canPriceBeForceOverrided
boolean
 
Responses 
200
Invoice updated successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


put/pay-int-api/invoices/{invoiceId}
Request samples 
application/json
{
  • "dueDate": "string",
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "additionalNotes": "string",
  • "shippingAmount": 0,
  • "taxPercentage": 0,
  • "feesPercentage": 0,
  • "discountPercentage": 0,
  • "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "achAllowFasterProcessing": true,
  • "customer": {
    },
  • "lineItems": [
    ],
  • "canPriceBeForceOverrided": true
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Deletes an invoice.
You can't delete published invoices.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice to delete.


 
header Parameters
x-api-version
string
 
Responses 
200
Invoice deleted successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


delete/pay-int-api/invoices/{invoiceId}
Request samples 
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Submits an invoice for processing.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the invoice to submit.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the details for invoice submission.


totalAmount
number <double> 
 
accountNumber
string or null
 
expirationYear
integer <int32> 
 
expirationMonth
integer <int32> 
 
securityCode
string or null
 
billingCountryId
integer <int32> 
 
billingPostalCode
string or null
 
savePaymentMethod
boolean
 
Responses 
200
OK


400
Bad Request


404
Not Found


500
Internal Server Error


post/pay-int-api/invoices/{id}/submit
Request samples 
application/json
{
  • "totalAmount": 0,
  • "accountNumber": "string",
  • "expirationYear": 0,
  • "expirationMonth": 0,
  • "securityCode": "string",
  • "billingCountryId": 0,
  • "billingPostalCode": "string",
  • "savePaymentMethod": true
}
Response samples 
application/json
{
  • "success": true,
  • "paymentMethodCreated": true,
  • "customerInfoSaved": true
}
Submits an invoice for processing.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
id
required
string <uuid> 
The unique identifier of the invoice to submit.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the details for invoice submission.


routingNumber
string or null
 
accountNumber
string or null
 
accountType
integer <int32>  (PaymentIntegrations.Contracts.Enums.AccountType) 
Possible values:


    

  • 1 - Checking: 
    • 

  • 2 - Savings: 
    • 



 Enum: 1 2  
accountHolderType
integer <int32>  (PaymentIntegrations.Contracts.Enums.AccountHolderType) 
Possible values:


    

  • 1 - Business: 
    • 

  • 2 - Personal: 
    • 



 Enum: 1 2  
firstName
string or null
 
lastName
string or null
 
companyName
string or null
 
email
string or null
 
mobileNumber
string or null
 
smsNotification
boolean
 
addressLine1
string or null
 
addressLine2
string or null
 
city
string or null
 
stateId
integer <int32> 
 
billingPostalCode
string or null
 
savePaymentMethod
boolean
 
authorizeBankWithdrawal
boolean
 
authorizationConsentTimestamp
string <date-time> 
Timestamp when customer checked the authorization checkbox.
Required for ACH compliance audit logging.


 
Responses 
200
OK


400
Bad Request


404
Not Found


500
Internal Server Error


post/pay-int-api/invoices/{id}/ach/submit
Request samples 
application/json
{
  • "routingNumber": "string",
  • "accountNumber": "string",
  • "accountType": 1,
  • "accountHolderType": 1,
  • "firstName": "string",
  • "lastName": "string",
  • "companyName": "string",
  • "email": "string",
  • "mobileNumber": "string",
  • "smsNotification": true,
  • "addressLine1": "string",
  • "addressLine2": "string",
  • "city": "string",
  • "stateId": 0,
  • "billingPostalCode": "string",
  • "savePaymentMethod": true,
  • "authorizeBankWithdrawal": true,
  • "authorizationConsentTimestamp": "2019-08-24T14:15:22Z"
}
Response samples 
application/json
{
  • "success": true,
  • "paymentMethodCreated": true,
  • "customerInfoSaved": true
}
Gets the calculations for a specific invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice.


 
header Parameters
x-api-version
string
 
Responses 
200
OK


get/pay-int-api/invoices/{invoiceId}/calculations
Request samples 
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "subTotalAmount": 0,
  • "shippingAmount": 0,
  • "taxPercentage": 0,
  • "taxAmount": 0,
  • "feesPercentage": 0,
  • "feesAmount": 0,
  • "discountPercentage": 0,
  • "discountAmount": 0,
  • "surchargePercentage": 0,
  • "surchargeAmount": 0,
  • "totalAmount": 0
}
Publishes an invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the details for publishing the invoice.


dueDate
string or null
 
cardPaymentProcessorId
string or null <uuid> 
 
achPaymentProcessorId
string or null <uuid> 
 
additionalNotes
string or null
 
shippingAmount
number or null <double> 
 
taxPercentage
number or null <double> 
 
feesPercentage
number or null <double> 
 
discountPercentage
number or null <double> 
 
merchantContactInfoId
string or null <uuid> 
 
customerId
string or null <uuid> 
 
achAllowFasterProcessing
boolean or null
 
object (PaymentIntegrations.Contracts.Invoices.InvoiceCustomerDto) 
 
Array of objects or null (PaymentIntegrations.Contracts.Invoices.InvoiceLineItemDto) 
 
canPriceBeForceOverrided
boolean
 
id
string or null <uuid> 
 
Responses 
200
OK


400
Bad Request


404
Not Found


500
Internal Server Error


post/pay-int-api/invoices/publish
Request samples 
application/json
{
  • "dueDate": "string",
  • "cardPaymentProcessorId": "db82121d-3317-4452-ab36-552196b0f55a",
  • "achPaymentProcessorId": "7795a840-221a-45e0-9419-a69eaa3463ff",
  • "additionalNotes": "string",
  • "shippingAmount": 0,
  • "taxPercentage": 0,
  • "feesPercentage": 0,
  • "discountPercentage": 0,
  • "merchantContactInfoId": "f5d826ad-fdaf-44d6-8e8e-3260a44e8639",
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "achAllowFasterProcessing": true,
  • "customer": {
    },
  • "lineItems": [
    ],
  • "canPriceBeForceOverrided": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Cancels an invoice.
Only invoices in published(Due, Past Due) status and not paid can be canceled.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice to cancel.


 
header Parameters
x-api-version
string
 
Responses 
200
Invoice cancelled successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


put/pay-int-api/invoices/{invoiceId}/cancel
Request samples 
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Marks an invoice as paid.
Only invoices in published(Due, Past Due) status and not paid can be marked as paid.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice to mark as paid.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the payment details.


paymentMethodTypeId
integer or null <int32> 
 
Responses 
200
Invoice marked as paid successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


put/pay-int-api/invoices/{invoiceId}/mark-as-paid
Request samples 
application/json
{
  • "paymentMethodTypeId": 0
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Sends an SMS notification for a published invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice for which to send the notification.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the details for the SMS notification.


phoneNumber
string or null
 
customerConsent
boolean
 
Responses 
200
SMS notification sent successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


post/pay-int-api/invoices/{invoiceId}/send-published-sms-notification
Request samples 
application/json
{
  • "phoneNumber": "string",
  • "customerConsent": true
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
Downloads an invoice as a PDF document.
Available only for published invoices.


SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice.


 
header Parameters
x-api-version
string
 
Responses 
200
OK


404
Not Found


500
Internal Server Error


get/pay-int-api/invoices/{invoiceId}/download-pdf
Request samples 
Response samples 
application/json
"string"
Sends an Email notification for the invoice.
SecurityBearer or Bearer or Bearer or Bearer 
Request 
path Parameters
invoiceId
required
string <uuid> 
The unique identifier of the invoice for which to send the notification.


 
header Parameters
x-api-version
string
 
Request Body schema: application/json
The request containing the details for the Email notification.


receiverEmail
string or null
 
customerConsent
boolean
 
Responses 
200
Email notification sent successfully.


400
Bad Request


404
Not Found


500
Internal Server Error


post/pay-int-api/invoices/{invoiceId}/send-email-notification
Request samples 
application/json
{
  • "receiverEmail": "string",
  • "customerConsent": true
}
Response samples 
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}
➔ Next to InvoicesSettings