Company and payments

Company configuration, payment methods, CAI and branches. All routes require authentication.

Company (Companies)

Method	Path	Description
GET	/companies	Get company data (by context)
PUT	/companies/:id	Update company

With API key the scope is the key's company.

Payment methods

Method	Path	Description
GET	/payments/methods	List payment methods
POST	/payments/methods	Create a payment method
PUT	/payments/methods/:id	Update a method

CAI / Ranges

Method	Path	Description
GET	/cai	List company CAI ranges

Branches

Method	Path	Description
GET	/branch	List branches

Scheduled invoices

Method	Path	Description
GET	/scheduled-invoices	List scheduled invoices
POST	/scheduled-invoices	Create a scheduled invoice

Document payments

List payments

GET /payments/documents/:documentId/payments

Register payment

POST /payments/documents/:documentId/payments

Confirm pending payment

POST /payments/documents/:documentId/payments/:paymentId/confirm

Cancel payment

POST /payments/documents/:documentId/payments/:paymentId/cancel

Apply credit note as payment

Include creditNoteId instead of paymentMethodId in the body.

Apply withholding certificate

Include withholdingDocumentId in the body.

---

Payment gateways (N1co / PixelPay)

GET /payments/gateways
POST /payments/gateways
PUT /payments/gateways/:id

To remove a gateway, use the web app (API keys cannot use DELETE).

Gateway callback endpoints:

• POST /webhooks/n1co
• POST /webhooks/pixelpay

---

Payment conditions

GET /payment-conditions
POST /payment-conditions
PUT /payment-conditions/:id

---

Advances

Check advance availability

GET /payments/source-documents/:sourceDocumentId/advance-availability

Apply advances

POST /payments/documents/:documentId/apply-advances-from-source

---

Common errors

• 401: Token or API key required.
• 403: No permission for the resource.
• 400: Amount exceeds pending total, inactive payment method, or cash condition not met.

Back to API index