Starts collection of every payment request raised for this invoice by the named methods again. Those payment requests keep being collected even while the customer as a whole is paused. Methods that are not named keep their current state.
Adfin API (1.0.0)
Adfin uses OAuth 2.0 access tokens to authenticate all API requests.
There are two contexts in which tokens are issued:
Biller Access Tokens — Generated via the Authorization Code flow when a biller connects their Adfin account. These tokens grant access to that biller's data (invoices, payment requests, customers, etc.).
Platform Access Tokens — Generated via the Client Credentials flow when a platform authenticates as itself rather than as one of its billers. A platform uses one to manage its own webhook subscriptions under
/api/apps/{clientId}/webhooks.
- Mock serverhttps://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{invoiceId}:resume_collection
- Production API Server URLhttps://api.adfin.com/api/invoices/{invoiceId}:resume_collection
- Staging API Server URLhttps://api.staging.adfin.com/api/invoices/{invoiceId}:resume_collection
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{invoiceId}:resume_collection' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"collectionMethods": [
"AUTO_COLLECT"
]
}'Request
Stops collection of every payment request raised for this invoice by the named methods, leaving the customer's other invoices alone. Methods that are not named keep collecting, and a method that is already paused stays as it is.
- Mock serverhttps://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{invoiceId}:pause_collection
- Production API Server URLhttps://api.adfin.com/api/invoices/{invoiceId}:pause_collection
- Staging API Server URLhttps://api.staging.adfin.com/api/invoices/{invoiceId}:pause_collection
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{invoiceId}:pause_collection' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"collectionMethods": [
"AUTO_COLLECT"
]
}'- Mock serverhttps://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{id}
- Production API Server URLhttps://api.adfin.com/api/invoices/{id}
- Staging API Server URLhttps://api.staging.adfin.com/api/invoices/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://developer.adfin.com/_mock/products/direct-integration/direct-integration-api-reference/invoices/{id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The Invoice data is successfully retrieved
The number of the invoice. Can be empty when creating the invoice without an invoice number,but it will be automatically generated when the invoice is pushed to an accounting software. Once set, serves as a unique value that can be used as an idempotency key.
The invoice total amount. Includes tax amount, amount paid or reduced with credit notes)
The invoice status
The reason as predefined code why the invoice is in a certain status
The source of the invoice
How tax is applied to line items from the invoice
The payment requests that were created for this invoice
The file source of invoice
References about this invoice from external platforms Adfin integrates with. Such as ID etc
The credit control status of the invoice
{ "id": "string", "invoiceNo": "string", "description": "string", "totalAmount": "string", "taxAmount": "string", "dueAmount": "string", "creditNotesAmount": "string", "dueDate": "2019-08-24T14:15:22Z", "issueDate": "2019-08-24T14:15:22Z", "creationTime": "2019-08-24T14:15:22Z", "lastUpdatedTime": "2019-08-24T14:15:22Z", "paidTime": "2019-08-24T14:15:22Z", "status": "DRAFT", "statusReasonCode": "MISSING_PAYER_CONTACT_DETAILS", "statusReason": "string", "invoiceSource": "FILE_UPLOAD", "customer": { "id": "string", "externalId": "string", "name": "string", "creationTime": "2019-08-24T14:15:22Z", "lastUpdatedTime": "2019-08-24T14:15:22Z", "people": [ … ], "addresses": [ … ], "directDebitMandate": { … }, "billerBankAccount": { … }, "timezone": "string", "discount": { … }, "externalData": [ … ], "tags": [ … ], "status": "ACTIVE", "statusReasonCode": "MERGED", "settings": { … }, "trackingItems": [ … ], "office": { … }, "collectionAgentId": "fe30a7f6-c47c-4051-9601-bd9dbc464447" }, "itemsTaxType": "EXCLUSIVE", "instalmentPlanDetails": { "cadence": { … } }, "items": [ { … } ], "paymentRequests": [ { … } ], "scheduleDetails": { "scheduleId": "string", "scheduleNo": "string", "type": "RECURRING" }, "creditNotes": [ { … } ], "fileSource": "NONE", "externalData": [ { … } ], "creditControlStatus": "AT_RISK", "workflowType": "AUTO_COLLECT", "customFields": [ { … } ], "office": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "trackingItemId": "c7c7fc03-0b17-402e-aa79-1d532a6db210", "details": { … } } }