Codat Get Create Payment Model Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "get-create-payment-model",
"method": "GET",
"path": "/companies/{companyId}/connections/{connectionId}/options/payments",
"summary": "Get create payment model",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"name": "FreeAgent",
"example": {
"type": "Object",
"displayName": "Payment",
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"properties": {
"accountRef": {
"type": "Object",
"displayName": "Nominal Account Reference",
"description": "Reference to the nominal account the payment is linked to",
"properties": {
"id": {
"type": "String",
"displayName": "Account ID",
"description": "The identifier for the account",
"required": true,
"validation": {
"warnings": [
{
"field": "AccountRef.Id",
"details": "Must match the ID of an existing account."
}
],
"information": []
}
}
},
"required": true
},
"date": {
"type": "DateTime",
"displayName": "Date",
"description": "The date the payment was recorded",
"required": true
},
"totalAmount": {
"type": "Number",
"displayName": "Total Amount",
"description": "The total amount of the payment, inclusive of discounts and tax",
"required": true,
"validation": {
"warnings": [
{
"field": "TotalAmount",
"details": "Must match the sum of the line amounts."
}
],
"information": []
}
},
"currency": {
"type": "String",
"displayName": "Currency",
"description": "Currency of the payment",
"required": true
},
"currencyRate": {
"type": "Number",
"displayName": "Currency Exchange Rate",
"description": "The exchange rate between the currency of the payment and the base currency of the company",
"required": true
},
"lines": {
"type": "Array",
"displayName": "Lines",
"description": "A collection of payment lines",
"properties": {
"amount": {
"type": "Number",
"displayName": "Amount",
"description": "The total amount for the line in the payment currency",
"required": true,
"validation": {
"warnings": [],
"information": [
{
"field": "Lines.Amount",
"details": "Must match the sum of the link amounts."
}
]
}
},
"links": {
"type": "Array",
"displayName": "Links",
"description": "A collection of linked transactions",
"properties": {
"id": {
"type": "String",
"displayName": "Identifier",
"description": "The identifier for the referenced transaction",
"required": true
},
"amount": {
"type": "Number",
"displayName": "Amount",
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"required": true
},
"type": {
"type": "String",
"displayName": "Link Type",
"description": "The type of transaction that is being linked",
"options": [
{
"value": "Invoice",
"type": "String",
"displayName": "Invoice",
"required": false
},
{
"value": "CreditNote",
"type": "String",
"displayName": "CreditNote",
"required": false
},
{
"value": "Other",
"type": "String",
"displayName": "Other",
"required": false
}
],
"required": true
}
},
"required": true
}
},
"required": true,
"validation": {
"warnings": [
{
"field": "Lines",
"details": "Only one line may be specified"
}
],
"information": []
}
}
},
"required": true
}
},
{
"status": "200",
"contentType": "application/json",
"name": "FreshBooks",
"example": {
"type": "Object",
"displayName": "Payment",
"description": "A payment represents an allocation of transactions across an 'accounts receivable' account (customer)",
"properties": {
"date": {
"type": "DateTime",
"displayName": "Date",
"description": "The date the payment was recorded",
"required": true
},
"lines": {
"type": "Array",
"displayName": "Lines",
"description": "A collection of payment lines",
"properties": {
"links": {
"type": "Array",
"displayName": "Links",
"description": "A collection of linked transactions",
"properties": {
"id": {
"type": "String",
"displayName": "Identifier",
"description": "The identifier for the referenced transaction",
"required": true
},
"amount": {
"type": "Number",
"displayName": "Amount",
"description": "The amount by which the balance of the linked entity is altered, in the currency of the linked entity",
"required": true
},
"type": {
"type": "String",
"displayName": "Link Type",
"description": "The type of transaction that is being linked",
"required": true
}
},
"required": true,
"validation": {
"warnings": [
{
"field": "Lines.Links",
"details": "Payment Amount must not exceed Invoice Amount Due or available Customer Credit"
},
{
"field": "Lines.Links",
"details": "Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount"
}
],
"information": []
}
}
},
"required": true,
"validation": {
"warnings": [
{
"field": "Lines",
"details": "Only one line is supported"
}
],
"information": []
}
},
"currency": {
"type": "String",
"displayName": "Currency",
"description": "Currency of the payment",
"options": [
{
"value": "AED",
"type": "Array",
"displayName": "AED",
"required": false
},
{
"value": "AFN",
"type": "Array",
"displayName": "AFN",
"required": false
},
{
"value": "ALL",
"type": "Array",
"displayName": "ALL",
"required": false
},
{
"value": "AMD",
"type": "Array",
"displayName": "AMD",
"required": false
},
{
"value": "ANG",
"type": "Array",
"displayName": "ANG",
"required": false
},
{
"value": "AOA",
"type": "Array",
"displayName": "AOA",
"required": false
},
{
"value": "ARS",
"type": "Array",
"displayName": "ARS",
"required": false
},
{
"value": "AUD",
"type": "Array",
"displayName": "AUD",
"required": false
},
{
"value": "AWG",
"type": "Array",
"displayName": "AWG",
"required": false
},
{
"value": "AZN",
"type": "Array",
"displayName": "AZN",
"required": false
},
{
"value": "BAM",
"type": "Array",
"displayName": "BAM",
"required": false
},
{
"value": "BBD",
"type": "Array",
"displayName": "BBD",
"required": false
},
{
"value": "BDT",
"type": "Array",
"displayName": "BDT",
"required": false
},
{
"value": "BGN",
"type": "Array",
"displayName": "BGN",
"required": false
},
{
"value": "BHD",
"type": "Array",
"displayName": "BHD",
"required": false
},
{
"value": "BIF",
"type": "Array",
"displayName": "BIF",
"required": false
},
{
"value": "BMD",
"type": "Array",
"displayName": "BMD",
"required": false
},
{
"value": "BND",
"type": "Array",
"displayName": "BND",
"required": false
},
{
"value": "BOB",
"type": "Array",
"displayName": "BOB",
"required": false
},
{
"value": "BRL",
"type": "Array",
"displayName": "BRL",
"required": false
},
{
"value": "BSD",
"type": "Array",
"displayName": "BSD",
"required": false
},
{
"value": "BTN",
"type": "Array",
"displayName": "BTN",
"required": false
},
{
"value": "BWP",
"type": "Array",
"displayName": "BWP",
"required": false
},
{
"value": "BYR",
"type": "Array",
"displayName": "BYR",
"required": false
},
{
"value": "BZD",
"type": "Array",
"displayName": "BZD",
"required": false
},
{
"value": "CAD",
"type": "Array",
"displayName": "CAD",
"required": false
},
{
"value": "CDF",
"type": "Array",
"displayName": "CDF",
"required": false
},
{
"value": "CHF",
"type": "Array",
"displayName": "CHF",
"required": false
},
{
"value": "CLP",
"type": "Array",
"displayName": "CLP",
"required": false
},
{
"value": "CNY",
"type": "Array",
"displayName": "CNY",
"required": false
},
{
"value": "COP",
"type": "Array",
"displayName": "COP",
"required": false
},
{
"value": "CRC",
"type": "Array",
"displayName": "CRC",
"required": false
},
{
"value": "CUC",
"type": "Array",
"displayName": "CUC",
"required": false
},
{
"value": "CUP",
"type": "Array",
"displayName": "CUP",
"required": false
},
{
"value": "CVE",
"type": "Array",
"displayName": "CVE",
"required": false
},
{
"value": "CZK",
"type": "Array",
"displayName": "CZK",
"required": false
},
{
"value": "DJF",
"type": "Array",
"displayName": "DJF",
"required": false
},
{
"value": "DKK",
"type": "Array",
"displayName": "DKK",
"required": false
},
{
"value": "DOP",
"type": "Array",
"displayName": "DOP",
"required": false
},
{
"value": "DZD",
"type": "Array",
"displayName": "DZD",
"required": false
},
{
"value": "EGP",
"type": "Array",
"displayName": "EGP",
"required": false
},
{
"value": "ERN",
"type": "Array",
"displayName": "ERN",
"required": false
},
{
"value": "ETB",
"type": "Array",
"displayName": "ETB",
"required": false
},
{
"value": "EUR",
"type": "Array",
"displayName": "EUR",
"required": false
},
{
"value": "FJD",
"type": "Array",
"displayName": "FJD",
"required": false
},
{
"value": "FKP",
"type": "Array",
"displayName": "FKP",
"required": false
},
{
"value": "GBP",
"type": "Array",
"displayName": "GBP",
"required": false
},
{
"value": "GEL",
"type": "Array",
"displayName": "GEL",
"required": false
},
{
"value": "GGP",
"type": "Array",
"displayName": "GGP",
"required": false
},
{
"value": "GHS",
"type": "Array",
"displayName": "GHS",
"required": false
},
{
"value": "GIP",
"type": "Array",
"displayName": "GIP",
"required": false
},
{
"value": "GMD",
"type": "Array",
"displayName": "GMD",
"required": false
},
{
"value": "GNF",
"type": "Array",
"displayName": "GNF",
"required": false
},
{
"value": "GTQ",
"type": "Array",
"displayName": "GTQ",
"required": false
},
{
"value": "GYD",
"type": "Array",
"displayName": "GYD",
"required": false
},
{
"value": "HKD",
"type": "Array",
"displayName": "HKD",
"required": false
},
{
"value": "HNL",
"type": "Array",
"displayName": "HNL",
"required": false
},
{
"value": "HRK",
"type": "Array",
"displayName": "HRK",
"required": false
},
{
"value": "HTG",
"type": "Array",
"displayName": "HTG",
"required": false
},
{
"value": "HUF",
"type": "Array",
"displayName": "HUF",
"required": false
},
{
"value": "IDR",
"type": "Array",
"displayName": "IDR",
"required": false
},
{
"value": "ILS",
"type": "Array",
"displayName": "ILS",
"required": false
},
{
"value": "IMP",
"type": "Array",
"displayName": "IMP",
"required": false
},
{
"value": "INR",
"type": "Array",
"displayName": "INR",
"required": false
},
{
"value": "IQD",
"type": "Array",
"displayName": "IQD",
"required": false
},
{
"value": "IRR",
"type": "Array",
"displayName": "IRR",
"required": false
},
{
"value": "ISK",
"type": "Array",
"displayName": "ISK",
"required": false
},
{
"value": "JEP",
"type": "Array",
"displayName": "JEP",
"required": false
},
{
"value": "JMD",
"type": "Array",
"displayName": "JMD",
"required": false
},
{
"value": "JOD",
"type": "Array",
"displayName": "JOD",
"required": false
},
{
"value": "JPY",
"type": "Array",
"displayName": "JPY",
"required": false
},
{
"value": "KES",
"type": "Array",
"displayName": "KES",
"required": false
},
{
"value": "KGS",
"type": "Array",
"displayName": "KGS",
"required": false
},
{
"value": "KHR",
"type": "Array",
"displayName": "KHR",
"required": false
},
{
"value": "KMF",
"type": "Array",
"displayName": "KMF",
"required": false
},
{
"value": "KPW",
"type": "Array",
"displayName": "KPW",
"required": false
},
{
"value": "KRW",
"type": "Array",
"displayName": "KRW",
"required": false
},
{
"value": "KWD",
"type": "Array",
"displayName": "KWD",
"required": false
},
{
"value": "KYD",
"type": "Array",
"displayName": "KYD",
"required": false
},
{
"value": "KZT",
"type": "Array",
"displayName": "KZT",
"required": false
},
{
"value": "LAK",
"type": "Array",
"displayName": "LAK",
"required": false
},
{
"value": "LBP",
"type": "Array",
"displayName": "LBP",
"required": false
},
{
"value": "LKR",
"type": "Array",
"displayName": "LKR",
"required": false
},
{
"value": "LRD",
"type": "Array",
"displayName": "LRD",
"required": false
},
{
"value": "LSL",
"type": "Array",
"displayName": "LSL",
"required": false
},
{
"value": "LYD",
"type": "Array",
"displayName": "LYD",
"required": false
},
{
"value": "MAD",
"type": "Array",
"displayName": "MAD",
"required": false
},
{
"value": "MDL",
"type": "Array",
"displayName": "MDL",
"required": false
},
{
"value": "MGA",
"type": "Array",
"displayName": "MGA",
"required": false
},
{
"value": "MKD",
"type": "Array",
"displayName": "MKD",
"required": false
},
{
"value": "MMK",
"type": "Array",
"displayName": "MMK",
"required": false
},
{
"value": "MNT",
"type": "Array",
"displayName": "MNT",
"required": false
},
{
"value": "MOP",
"type": "Array",
"displayName": "MOP",
"required": false
},
{
"value": "MRO",
"type": "Array",
"displayName": "MRO",
"required": false
},
{
"value": "MUR",
"type": "Array",
"displayName": "MUR",
"required": false
},
{
"value": "MVR",
"type": "Array",
"displayName": "MVR",
"required": false
},
{
"value": "MWK",
"type": "Array",
"displayName": "MWK",
"required": false
},
{
"value": "MXN",
"type": "Array",
"displayName": "MXN",
"required": false
},
{
"value": "MYR",
"type": "Array",
"displayName": "MYR",
"required": false
},
{
"value": "MZN",
"type": "Array",
"displayName": "MZN",
"required": false
},
{
"value": "NAD",
"type": "Array",
"displayName": "NAD",
"required": false
},
{
"value": "NGN",
"type": "Array",
"displayName": "NGN",
"required": false
},
{
"value": "NIO",
"type": "Array",
"displayName": "NIO",
"required": false
},
{
"value": "NOK",
"type": "Array",
"displayName": "NOK",
"required": false
},
{
"value": "NPR",
"type": "Array",
"displayName": "NPR",
"required": false
},
{
"value": "NZD",
"type": "Array",
"displayName": "NZD",
"required": false
},
{
"value": "OMR",
"type": "Array",
"displayName": "OMR",
"required": false
},
{
"value": "PAB",
"type": "Array",
"displayName": "PAB",
"required": false
},
{
"value": "PEN",
"type": "Array",
"displayName": "PEN",
"required": false
},
{
"value": "PGK",
"type": "Array",
"displayName": "PGK",
"required": false
},
{
"value": "PHP",
"type": "Array",
"displayName": "PHP",
"required": false
},
{
"value": "PKR",
"type": "Array",
"displayName": "PKR",
"required": false
},
{
"value": "PLN",
"type": "Array",
"displayName": "PLN",
"required": false
},
{
"value": "PYG",
"type": "Array",
"displayName": "PYG",
"required": false
},
{
"value": "QAR",
"type": "Array",
"displayName": "QAR",
"required": false
},
{
"value": "RON",
"type": "Array",
"displayName": "RON",
"required": false
},
{
"value": "RSD",
"type": "Array",
"displayName": "RSD",
"required": false
},
{
"value": "RUB",
"type": "Array",
"displayName": "RUB",
"required": false
},
{
"value": "RWF",
"type": "Array",
"displayName": "RWF",
"required": false
},
{
"value": "SAR",
"type": "Array",
"displayName": "SAR",
"required": false
},
{
"value": "SBD",
"type": "Array",
"displayName": "SBD",
"required": false
},
{
"value": "SCR",
"type": "Array",
"displayName": "SCR",
"required": false
},
{
"value": "SDG",
"type": "Array",
"displayName": "SDG",
"required": false
},
{
"value": "SEK",
"type": "Array",
"displayName": "SEK",
"required": false
},
{
"value": "SGD",
"type": "Array",
"displayName": "SGD",
"required": false
},
{
"value": "SHP",
"type": "Array",
"displayName": "SHP",
"required": false
},
{
"value": "SLL",
"type": "Array",
"displayName": "SLL",
"required": false
},
{
"value": "SOS",
"type": "Array",
"displayName": "SOS",
"required": false
},
{
"value": "SPL",
"type": "Array",
"displayName": "SPL",
"required": false
},
{
"value": "SRD",
"type": "Array",
"displayName": "SRD",
"required": false
},
{
"value": "STD",
"type": "Array",
"displayName": "STD",
"required": false
},
{
"value": "SVC",
"type": "Array",
"displayName": "SVC",
"required": false
},
{
"value": "SYP",
"type": "Array",
"displayName": "SYP",
"required": false
},
{
"value": "SZL",
"type": "Array",
"displayName": "SZL",
"required": false
},
{
"value": "THB",
"type": "Array",
"displayName": "THB",
"required": false
},
{
"value": "TJS",
"type": "Array",
"displayName": "TJS",
"required": false
},
{
"value": "TMT",
"type": "Array",
"displayName": "TMT",
"required": false
},
{
"value": "TND",
"type": "Array",
"displayName": "TND",
"required": false
},
{
"value": "TOP",
"type": "Array",
"displayName": "TOP",
"required": false
},
{
"value": "TRY",
"type": "Array",
"displayName": "TRY",
"required": false
},
{
"value": "TTD",
"type": "Array",
"displayName": "TTD",
"required": false
},
{
"value": "TVD",
"type": "Array",
"displayName": "TVD",
"required": false
},
{
"value": "TWD",
"type": "Array",
"displayName": "TWD",
"required": false
},
{
"value": "TZS",
"type": "Array",
"displayName": "TZS",
"required": false
},
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codat/refs/heads/main/examples/codat-get-create-payment-model-example.json