Payment Types
A payment type defines a way customers can pay, such as Direct Debit, credit card, bank transfer or cheque, along with its terms, fees, and whether it can be collected automatically. See Payment Types and Records for the user-facing reference.
Methods
Section titled “Methods”Retrieve Single Payment Type
Section titled “Retrieve Single Payment Type”/backend/api/v1/paymentTypes/ID - fetch the payment type with the specified ID.
List Payment Types
Section titled “List Payment Types”/backend/api/v1/paymentTypes/ - list all payment types.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include payment types with a higher ID |
createdSince | datetime | No | Only include payment types created since the given time |
updatedSince | datetime | No | Only include payment types updated since the given time |
/backend/api/v1/paymentTypes/ - add a new payment type. The newly-added payment type will be returned.
/backend/api/v1/paymentTypes/ID - update the payment type with the specified ID. The modified payment type will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/paymentTypes/ID - delete the payment type with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| paymentTypeName | Payment Type | Text | Name of the payment type |
| paymentTypeDisplayName | Payment Type (Display) | Text | Display name for the payment type shown to users |
| paymentTypeShortName | Payment Type (Short) | Text | Short abbreviation for the payment type |
| paymentTypeDisplayClass | Payment Type Display Class | Text | CSS class name for styling the payment type display |
| paymentTypeDisplayPosition | Payment Type Display Position | Number | Numerical position for ordering payment types in displays |
| availability | Payment Type Availability | Preset Value | Availability of this payment type (Headline, Standard, or Historic) |
| paymentTypeUseFor | Use For | Preset Value(s) | Array of usage context names where this payment type can be used |
| paymentTypeUseForPaymentCardProviders | Use For Payment Card Providers | Preset Value(s) | Array of payment card provider names this payment type can be used with |
| paymentTypeCode | Payment Type Code | Text | Code identifier for the payment type, typically for accounting packages |
| displayOnInvoice | Display on Invoice | Preset Value | Whether this payment type should be shown on customer invoices |
| manualBillingFee | Manual Billing Fee | Currency | Additional fee charged for manual billing with this payment type |
| paymentThreshold | Payment Threshold | Currency | Minimum amount required for payments using this payment type |
| finalBillPaymentThreshold | Final Bill Payment Threshold | Currency | Minimum amount required for payments using this payment type for Final Bill customers |
| finalBillShutdownThreshold | Final Bill Shutdown Threshold | Currency | Threshold balance for automatically closing Final Bill accounts |
| paymentTerms | Payment Terms | Number | Number of days/months for payment terms with this payment type |
| paymentTermsType | Payment Terms Type | Preset Value | Unit type name for payment terms |
| paymentGraceDays | Grace Period (Days) | Number | Default Grace Period (in days) for when invoices using this payment type are treated as overdue; customer Grace Period overrides when set. |
| inDirectDebitRun | Include In Direct Debit Run | Preset Value | Whether payments of this type should be included in direct debit collection runs |
| inPaymentCardRun | Include In Payment Card Run | Preset Value | Whether payments of this type should be included in payment card collection runs |
| id | Payment Type ID | Text | The unique identifier for this payment type |