Sales Invoices Payments

Create and retrieve payment records for sales invoices.

List sales invoices payments

get

Retrieves a paginated list of all sales invoice payments for the specified consent.

System support

System	Status
Fortnox	✅ Supported
Bjorn Lunden	⛔ Can't be supported
Spiris	✅ Supported
Tripletex	📞 Not supported / contact us
Visma e-conomic	✅ Supported
Billy	✅ Supported
Visma Dinero	📞 Not supported / contact us
Procountor	📞 Not supported / contact us
Visma Netvisor	📞 Not supported / contact us
Microsoft Business Central	📞 Not supported / contact us
Exact Online	📞 Not supported / contact us
QuickBooks	📞 Not supported / contact us
Xero	🔧 Under development / beta release
Bokio	📞 Not supported / contact us

Authorizations

ApiKey

x-api-keystringRequired

Use the API key to access all API endpoints.

Path parameters

consentIdstring · uuidRequired

Identifier of the consent representing the connection to the accounting system.

Header parameters

x-correlation-idstring · uuidRequired

Unique identifier used to correlate and trace this request.

Responses

200

Returns a paginated list of sales invoice payments for the specified consent.

application/json

Represents a paginated result containing metadata and a collection of items.

401

Missing or invalid authentication credentials.

application/json

403

Not authorized to access this resource.

application/json

501

This operation is not supported by the connected accounting system.

application/json

get

/api/v1/consents/{consentId}/salesinvoices/payments

HTTPcURLJavaScriptPython

GET /accounting/api/v1/consents/{consentId}/salesinvoices/payments HTTP/1.1
Host: apione.zwapgrid.com
x-api-key: YOUR_API_KEY
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "meta": {
    "totalResources": 10,
    "totalPages": 1,
    "currentPage": 1
  },
  "data": [
    {
      "id": "59",
      "paymentId": "59",
      "reference": "PAY-59",
      "receivedDate": "2022-06-01",
      "paidDate": "2022-06-01",
      "bookedIndicator": true,
      "bookedDate": "2022-06-02",
      "accountingAccount": {
        "id": "5233",
        "accountingAccountId": "5233",
        "reference": "5233",
        "standardAccountingAccountId": null,
        "name": "Bank account",
        "active": null,
        "postable": null,
        "description": {
          "languageId": "ENG",
          "text": "Main bank"
        },
        "descriptions": [
          {
            "languageId": "ENG",
            "text": "Main bank"
          }
        ],
        "accountingAccountTypeCode": null,
        "financialDimensions": []
      },
      "status": null,
      "billingReferences": [
        {
          "invoiceDocumentReferences": [
            {
              "id": "INV-001",
              "schemeId": "invoiceId"
            }
          ]
        }
      ],
      "documentCurrencyCode": {
        "currency": "DKK",
        "currencyId": "DKK",
        "currencyRate": 1
      },
      "amount": 500,
      "creditAmount": {
        "amount": 500,
        "currencyId": "DKK"
      },
      "debitAmount": {
        "amount": 0,
        "currencyId": "DKK"
      }
    }
  ]
}

List payments from a single sales invoice

get

Retrieves a paginated list of payments for a specific sales invoice.

System support

System	Status
Fortnox	✅ Supported
Bjorn Lunden	✅ Supported
Spiris	📞 Not supported / contact us
Tripletex	📞 Not supported / contact us
Visma e-conomic	📞 Not supported / contact us
Billy	✅ Supported
Visma Dinero	✅ Supported
Procountor	🔧 Under development / beta release
Visma Netvisor	📞 Not supported / contact us
Microsoft Business Central	📞 Not supported / contact us
Exact Online	📞 Not supported / contact us
QuickBooks	📞 Not supported / contact us
Xero	🔧 Under development / beta release
Bokio	📞 Not supported / contact us

Authorizations

ApiKey

x-api-keystringRequired

Use the API key to access all API endpoints.

Path parameters

consentIdstring · uuidRequired

Identifier of the consent representing the connection to the accounting system.

salesInvoiceIdstringRequired

Identifier of the sales invoice.

Header parameters

x-correlation-idstring · uuidRequired

Unique identifier used to correlate and trace this request.

Responses

200

Returns a paginated list of sales invoice payments for the specified consent.

application/json

Represents a paginated result containing metadata and a collection of items.

401

Missing or invalid authentication credentials.

application/json

403

Not authorized to access this resource.

application/json

501

This operation is not supported by the connected accounting system.

application/json

get

/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments

HTTPcURLJavaScriptPython

GET /accounting/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments HTTP/1.1
Host: apione.zwapgrid.com
x-api-key: YOUR_API_KEY
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "meta": {
    "totalResources": 10,
    "totalPages": 1,
    "currentPage": 1
  },
  "data": [
    {
      "id": "59",
      "paymentId": "59",
      "reference": "PAY-59",
      "receivedDate": "2022-06-01",
      "paidDate": "2022-06-01",
      "bookedIndicator": true,
      "bookedDate": "2022-06-02",
      "accountingAccount": {
        "id": "5233",
        "accountingAccountId": "5233",
        "reference": "5233",
        "standardAccountingAccountId": null,
        "name": "Bank account",
        "active": null,
        "postable": null,
        "description": {
          "languageId": "ENG",
          "text": "Main bank"
        },
        "descriptions": [
          {
            "languageId": "ENG",
            "text": "Main bank"
          }
        ],
        "accountingAccountTypeCode": null,
        "financialDimensions": []
      },
      "status": null,
      "billingReferences": [
        {
          "invoiceDocumentReferences": [
            {
              "id": "INV-001",
              "schemeId": "invoiceId"
            }
          ]
        }
      ],
      "documentCurrencyCode": {
        "currency": "DKK",
        "currencyId": "DKK",
        "currencyRate": 1
      },
      "amount": 500,
      "creditAmount": {
        "amount": 500,
        "currencyId": "DKK"
      },
      "debitAmount": {
        "amount": 0,
        "currencyId": "DKK"
      }
    }
  ]
}

Create a sales invoice payment

post

Creates a new payment for the specified sales invoice.

System support

System	Status
Fortnox	✅ Supported
Bjorn Lunden	✅ Supported
Spiris	✅ Supported
Tripletex	📞 Not supported / contact us
Visma e-conomic	📞 Not supported / contact us
Billy	✅ Supported
Visma Dinero	📞 Not supported / contact us
Procountor	📞 Not supported / contact us
Visma Netvisor	📞 Not supported / contact us
Microsoft Business Central	📞 Not supported / contact us
Exact Online	📞 Not supported / contact us
QuickBooks	📞 Not supported / contact us
Xero	🔧 Under development / beta release
Bokio	📞 Not supported / contact us

Authorizations

ApiKey

x-api-keystringRequired

Use the API key to access all API endpoints.

Path parameters

consentIdstring · uuidRequired

Identifier of the consent representing the connection to the accounting system.

salesInvoiceIdstringRequired

Identifier of the sales invoice.

Header parameters

x-correlation-idstring · uuidRequired

Unique identifier used to correlate and trace this request.

Body

application/jsontext/jsonapplication/*+json

Represents input data for creating a sales invoice payment.

idstring · nullableOptional

Unique identifier for the payment.

referencestring · nullableOptional

Reference identifier for the payment.

receivedDatestring · nullableOptional

Date when the payment was received.

paidDatestring · nullableOptional

Date when the payment was made.

bookedIndicatorboolean · nullableOptional

Indicates whether the payment is booked.

bookedDatestring · nullableOptional

Date when the payment was booked.

amountnumber · nullableOptional

Monetary amount for the payment.

paymentIdstring · nullableOptionalDeprecated

Deprecated. Use ZG.AccountingService.AccountingModels.Dtos.Input.CreateInvoicePaymentDtoBase.Reference instead. External payment identifier. (Deprecated: Use Reference instead)

Responses

201

The sales invoice payment was created. Response includes a Location header with the URL of the created resource.

400

The request body or parameters are invalid.

application/json

403

Not authorized to access this resource.

application/json

501

This operation is not supported by the connected accounting system.

application/json

post

/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments

HTTPcURLJavaScriptPython

POST /accounting/api/v1/consents/{consentId}/salesinvoices/{salesInvoiceId}/payments HTTP/1.1
Host: apione.zwapgrid.com
x-api-key: YOUR_API_KEY
x-correlation-id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 616

{
  "id": null,
  "reference": null,
  "receivedDate": null,
  "paidDate": null,
  "bookedIndicator": null,
  "bookedDate": null,
  "accountingAccount": {
    "id": null,
    "reference": null,
    "standardAccountingAccountId": null,
    "name": null,
    "active": null,
    "postable": null,
    "descriptions": [
      {
        "text": null,
        "languageId": null
      }
    ],
    "accountingAccountTypeCode": {
      "code": null,
      "listId": null
    },
    "financialDimensions": [
      {
        "id": null,
        "reference": null,
        "type": null,
        "name": null,
        "description": null,
        "isActive": null
      }
    ]
  },
  "documentCurrencyCode": {
    "currencyId": null,
    "currencyRate": null
  },
  "amount": null,
  "creditAmount": {
    "amount": 1,
    "currencyId": null
  },
  "debitAmount": {
    "amount": 1,
    "currencyId": null
  }
}

application/jsontext/jsonapplication/*+json

No content