{
"openapi": "3.0.2",
"info": {
"description": "Generated on 17-09-2026",
"version": "28.3.0.0",
"title": "CAMP 365 FarPay API computerCamp/farpay/v1.0"
},
"servers": [
{
"url": "https://api.businesscentral.dynamics.com/v2.0/sandbox/api/computerCamp/farpay/v1.0"
},
{
"url": "https://api.businesscentral.dynamics.com/v2.0/production/api/computerCamp/farpay/v1.0"
}
],
"tags": [
{
"name": "activeAgreements"
},
{
"name": "collectionAgreements"
},
{
"name": "collectionPayments"
},
{
"name": "eventPayments"
}
],
"security": [
{
"oAuth2ClientCredentials": [
"https://api.businesscentral.dynamics.com/.default"
]
},
{
"bearerAuth": []
}
],
"paths": {
"/activeAgreements": {
"get": {
"description": "A link to change payment method/agreement of the member specified
This is a two step procedure starting with calling FarPay to get a link to the new agreement
Permissions: Read
Returns: A link to change the agreement
Conditions: A member is required. The member number must be supplied as a filter on memberNo, otherwise the call will fail with an error.
Examples:
GET:
The link for the given member: {environment}/api/computerCamp/farpay/v1.0/companies({company})/collectionAgreements?$filter=memberNo eq '{memberNo}'",
"summary": "Get entities from activeAgreements",
"tags": [
"activeAgreements"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"id",
"id desc",
"type",
"type desc",
"status",
"status desc",
"memberNo",
"memberNo desc",
"payerID",
"payerID desc",
"details",
"details desc",
"startDate",
"startDate desc",
"expireDate",
"expireDate desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"id",
"type",
"status",
"memberNo",
"payerID",
"details",
"startDate",
"expireDate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of activeAgreement",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.activeAgreement"
}
}
}
}
}
}
}
}
}
},
"/activeAgreements({id})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: id",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"get": {
"summary": "Get entity from activeAgreements by key",
"tags": [
"activeAgreements"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"id",
"type",
"status",
"memberNo",
"payerID",
"details",
"startDate",
"expireDate"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.activeAgreement"
}
}
}
}
}
}
},
"/collectionAgreements": {
"get": {
"description": "A link to change payment method/agreement of the member specified
This is a two step procedure starting with calling FarPay to get a link to the new agreement
Permissions: Read
Returns: A link to change the agreement
Conditions: A member is required
Examples:
GET:
The link for the given member: {environment}/api/computerCamp/farpay/v1.0/companies({company})/collectionAgreements?$filter=memberNo eq '{memberNo}'",
"summary": "Get entities from collectionAgreements",
"tags": [
"collectionAgreements"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"memberNo desc",
"farpayURL",
"farpayURL desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"farpayURL"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of collectionAgreement",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionAgreement"
}
}
}
}
}
}
}
}
}
},
"/collectionAgreements('{memberNo}')": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: memberNo",
"in": "path",
"name": "memberNo",
"required": true,
"schema": {
"type": "string",
"maxLength": 20
}
}
],
"get": {
"summary": "Get entity from collectionAgreements by key",
"tags": [
"collectionAgreements"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"memberNo",
"farpayURL"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionAgreement"
}
}
}
}
}
}
},
"/collectionPayments": {
"get": {
"description": "A list collections for the member specified
This is a two step procedure starting with calling FarPay for each unpaid invoice to get a token
This token is then added to the payment link returned
Note: FarPay payment type also contains BC payment type, if the type is payroll
OR
Information about a single invoice from invoice number
Permissions: Read
Returns: A list of collections
Conditions: A member is required
Examples:
GET:
All invoices for a given member: {environment}/api/computerCamp/farpay/v1.0/companies({company})/collectionPayments?$filter=memberNo eq '{memberNo}'
A specific invoice: {environment}/api/computerCamp/farpay/v1.0/companies({company})/collectionPayments?$filter=invoiceNo eq '{invoiceNo}'",
"summary": "Get entities from collectionPayments",
"tags": [
"collectionPayments"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"memberNo",
"memberNo desc",
"invoiceNo",
"invoiceNo desc",
"description",
"description desc",
"invoiceDate",
"invoiceDate desc",
"dueDate",
"dueDate desc",
"amount",
"amount desc",
"oldBalance",
"oldBalance desc",
"paymentAmount",
"paymentAmount desc",
"farpayURL",
"farpayURL desc",
"paymentStatusFarpay",
"paymentStatusFarpay desc",
"paymentType",
"paymentType desc",
"paymentID",
"paymentID desc",
"creditorNo",
"creditorNo desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"invoiceNo",
"description",
"invoiceDate",
"dueDate",
"amount",
"oldBalance",
"paymentAmount",
"farpayURL",
"paymentStatusFarpay",
"paymentType",
"paymentID",
"creditorNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of collectionPayment",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionPayment"
}
}
}
}
}
}
}
}
}
},
"/collectionPayments({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
}
}
],
"get": {
"summary": "Get entity from collectionPayments by key",
"tags": [
"collectionPayments"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"invoiceNo",
"description",
"invoiceDate",
"dueDate",
"amount",
"oldBalance",
"paymentAmount",
"farpayURL",
"paymentStatusFarpay",
"paymentType",
"paymentID",
"creditorNo"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.collectionPayment"
}
}
}
}
}
}
},
"/eventPayments": {
"get": {
"description": "A list event payments for the member specified
This is a two step procedure starting with calling FarPay for each unpaid event invoice to get a token
This token is then added to the payment link returned
OR
Information about a single event invoice from invoice number
Permissions: Read
Returns: A list of event invoices
Conditions: A member is required
Examples:
GET:
All invoices for a given member: {environment}/api/computerCamp/farpay/v1.0/companies({company})/eventPayments?$filter=memberNo eq '{memberNo}'
A specific invoice: {environment}/api/computerCamp/farpay/v1.0/companies({company})/eventPayments?$filter=invoiceNo eq '{invoiceNo}'",
"summary": "Get entities from eventPayments",
"tags": [
"eventPayments"
],
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"$ref": "#/components/parameters/top"
},
{
"$ref": "#/components/parameters/skip"
},
{
"$ref": "#/components/parameters/search"
},
{
"name": "$filter",
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
"in": "query",
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/count"
},
{
"name": "$orderby",
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"no desc",
"memberNo",
"memberNo desc",
"invoiceNo",
"invoiceNo desc",
"description",
"description desc",
"invoiceDate",
"invoiceDate desc",
"dueDate",
"dueDate desc",
"amount",
"amount desc",
"farpayURL",
"farpayURL desc",
"paymentStatusFarpay",
"paymentStatusFarpay desc",
"paymentType",
"paymentType desc"
]
}
}
},
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"invoiceNo",
"description",
"invoiceDate",
"dueDate",
"amount",
"farpayURL",
"paymentStatusFarpay",
"paymentType"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entities",
"content": {
"application/json": {
"schema": {
"type": "object",
"title": "Collection of eventPayment",
"properties": {
"@odata.count": {
"$ref": "#/components/schemas/count"
},
"value": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Microsoft.NAV.eventPayment"
}
}
}
}
}
}
}
}
}
},
"/eventPayments({no})": {
"parameters": [
{
"$ref": "#/components/parameters/company"
},
{
"description": "key: no",
"in": "path",
"name": "no",
"required": true,
"schema": {
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
}
}
],
"get": {
"summary": "Get entity from eventPayments by key",
"tags": [
"eventPayments"
],
"parameters": [
{
"name": "$select",
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
"no",
"memberNo",
"invoiceNo",
"description",
"invoiceDate",
"dueDate",
"amount",
"farpayURL",
"paymentStatusFarpay",
"paymentType"
]
}
}
},
{
"name": "$expand",
"description": "Select navigation properties to be returned, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
"in": "query",
"explode": false,
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string",
"enum": [
null
]
}
}
}
],
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Retrieved entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Microsoft.NAV.eventPayment"
}
}
}
}
}
}
},
"/$batch": {
"post": {
"summary": "Send a group of requests",
"description": "Group multiple requests into a single request payload, see [Batch Requests](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_BatchRequests).\n\n*Please note that \"Try it out\" is not supported for this request.*",
"tags": [
"Batch Requests"
],
"requestBody": {
"required": true,
"description": "Batch request",
"content": {
"multipart/mixed;boundary=request-separator": {
"example": "--request-separator\nContent-Type: application/http\nContent-Transfer-Encoding: binary\n\nGET educations HTTP/1.1\nAccept: application/json\n\n\n--request-separator--",
"schema": {
"type": "string"
}
}
}
},
"responses": {
"4XX": {
"$ref": "#/components/responses/error"
},
"200": {
"description": "Batch response",
"content": {
"multipart/mixed": {
"example": "--response-separator\nContent-Type: application/http\n\nHTTP/1.1 200 OK\nContent-Type: application/json\n\n{...}\n--response-separator--",
"schema": {
"type": "string"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Microsoft.NAV.activeAgreement": {
"title": "activeAgreement",
"type": "object",
"properties": {
"id": {
"description": "The unique identifier of the agreement in FarPay",
"type": "integer",
"format": "int32"
},
"type": {
"description": "The payment type of the agreement, e.g. Betalingsservice, MobilePay Subscriptions or a card type",
"type": "string",
"maxLength": 30,
"nullable": true
},
"status": {
"description": "The current status of the agreement",
"type": "string",
"maxLength": 10,
"nullable": true
},
"memberNo": {
"description": "The member the agreement belongs to",
"type": "string",
"maxLength": 20,
"nullable": true
},
"payerID": {
"description": "The identifier of the payer registered for the agreement",
"type": "string",
"maxLength": 30,
"nullable": true
},
"details": {
"description": "Additional details about the agreement",
"type": "string",
"maxLength": 30,
"nullable": true
},
"startDate": {
"description": "The date and time from which the agreement is valid",
"type": "string",
"format": "date-time",
"nullable": true
},
"expireDate": {
"description": "The date and time when the agreement expires",
"type": "string",
"format": "date-time",
"nullable": true
}
}
},
"Microsoft.NAV.collectionAgreement": {
"title": "collectionAgreement",
"type": "object",
"properties": {
"memberNo": {
"description": "The member who is to pay the invoice",
"type": "string",
"maxLength": 20
},
"farpayURL": {
"description": "The payment URL in FarPay",
"type": "string",
"maxLength": 250,
"nullable": true
}
}
},
"Microsoft.NAV.collectionPayment": {
"title": "collectionPayment",
"type": "object",
"properties": {
"no": {
"description": "The unique key of the record",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
},
"memberNo": {
"description": "The member who is to pay the invoice",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceNo": {
"description": "Invoice number for the unpaid invoices",
"type": "string",
"maxLength": 20,
"nullable": true
},
"description": {
"description": "Collection period",
"type": "string",
"maxLength": 100,
"nullable": true
},
"invoiceDate": {
"description": "The invoice date of the invoice",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"dueDate": {
"description": "The due date of the invoice",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"amount": {
"description": "Invoice Amount",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"oldBalance": {
"description": "Old balance",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"paymentAmount": {
"description": "Payment amount",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"farpayURL": {
"description": "The payment URL in FarPay",
"type": "string",
"maxLength": 150,
"nullable": true
},
"paymentStatusFarpay": {
"description": "The payment status of the invoice in Farpay",
"type": "string",
"maxLength": 20,
"nullable": true
},
"paymentType": {
"description": "The payment type of the invoice",
"type": "string",
"maxLength": 50,
"nullable": true
},
"paymentID": {
"description": "The payment ID of the invoice",
"type": "string",
"maxLength": 20,
"nullable": true
},
"creditorNo": {
"description": "The creditor number of the invoice",
"type": "string",
"maxLength": 10,
"nullable": true
}
}
},
"Microsoft.NAV.eventPayment": {
"title": "eventPayment",
"type": "object",
"properties": {
"no": {
"description": "The unique key of the record",
"anyOf": [
{
"type": "integer"
},
{
"type": "string"
}
],
"format": "int64",
"example": "42"
},
"memberNo": {
"description": "The member who is to pay the event invoice",
"type": "string",
"maxLength": 20,
"nullable": true
},
"invoiceNo": {
"description": "Invoice number for the unpaid event invoice",
"type": "string",
"maxLength": 20,
"nullable": true
},
"description": {
"description": "The event on the event invoice",
"type": "string",
"maxLength": 100,
"nullable": true
},
"invoiceDate": {
"description": "The invoice date of the event invoice",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"dueDate": {
"description": "The due date of the event invoice",
"type": "string",
"format": "date",
"example": "2017-04-13",
"nullable": true
},
"amount": {
"description": "The amount on the event invoice",
"anyOf": [
{
"type": "number"
},
{
"type": "string"
}
],
"format": "decimal",
"example": 0,
"nullable": true
},
"farpayURL": {
"description": "The payment URL in FarPay",
"type": "string",
"maxLength": 150,
"nullable": true
},
"paymentStatusFarpay": {
"description": "The payment status of the invoice in Farpay",
"type": "string",
"maxLength": 20,
"nullable": true
},
"paymentType": {
"description": "The payment type of the invoice",
"type": "string",
"maxLength": 50,
"nullable": true
}
}
},
"count": {
"anyOf": [
{
"type": "integer",
"minimum": 0
},
{
"type": "string"
}
],
"description": "The number of entities in the collection. Available when using the [$count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount) query option."
},
"error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"target": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"target": {
"type": "string"
}
}
}
},
"innererror": {
"type": "object",
"description": "The structure of this object is service-specific"
}
}
}
}
}
},
"parameters": {
"company": {
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"name": "company",
"description": "Kan findes i Business Central ved at åbne siden regnskabsoversigt, vælg derefter det ønskede regnskab. Åbn inspectoren ved at trykke ctrl+alt+F1. Marker værdien i feltet "id" ved at triple-klikke og kopier værdien."
},
"top": {
"name": "$top",
"in": "query",
"description": "Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)",
"schema": {
"type": "integer",
"minimum": 0
},
"example": 50
},
"skip": {
"name": "$skip",
"in": "query",
"description": "Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)",
"schema": {
"type": "integer",
"minimum": 0
}
},
"count": {
"name": "$count",
"in": "query",
"description": "Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)",
"schema": {
"type": "boolean"
}
},
"search": {
"name": "$search",
"in": "query",
"description": "Search items by search phrases, see [Searching](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch)",
"schema": {
"type": "string"
}
}
},
"responses": {
"error": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"bearerFormat": "JwT",
"type": "http",
"description": "Hvis du vil teste i Swagger UI, skal du anvende denne.
",
"scheme": "bearer"
},
"oAuth2ClientCredentials": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "https://login.microsoftonline.com/camp1.onmicrosoft.com/oauth2/v2.0/token",
"scopes": {
"https://api.businesscentral.dynamics.com/.default": "Default permissions"
}
}
},
"description": "HUSK at indsætte dit tenant id eller domæne.
"
}
}
}
}