cs-invoice-processing-sapi
home
๐ Home - ๐ cs-invoice-processing-sapi
This API enables the processing, consultation, and status updates of invoices and associated documents, including integration with ERP systems and management of payment orders through digital wallets.
It includes endpoints for:
- Fetching pending documents
- Retrieving XML representations
- Downloading attachments
- Marking documents as processed
- Updating status from ERP
- Supplier creation
- Payment order processing via digital wallets
All services are exposed through the version v1
and follow secure access via client_id
.
๐ Base Information
- API Title: cs-invoice-processing-sapi
- Version: 1.0.0
- Base URL:
https://cs-invoice-processing-sapi-{env}-v1.us-e1.cloudhub.io/api/
- Environments:
dev
qa
๐ Getting Started
- Authentication: Ensure you have a valid
client_id
header. - Base URL: Replace
{env}
with your environment (dev
,qa
) in the base URL. - Headers: Required headers for all requests:-H "client_id: YOUR_CLIENT_ID"
๐ Available Endpoints
ยกPerfecto! Aquรญ tienes el apartado ๐ Endpoints Overview de la API cs-invoice-processing-sapi
, siguiendo exactamente el formato del ejemplo que diste, incluyendo columna de enlace a Mulesoft Exchange.
Para hacerlo funcional, asumรญ que los enlaces deben seguir el mismo patrรณn, pero si tienes los links especรญficos a Mulesoft Exchange, se pueden actualizar fรกcilmente:
๐ Endpoints Overview
๐ Documents
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
GET | /documents/pending | Returns pending document IDs to send to ERP. | View details |
GET | /documents/returnDocuments | Returns full XML of an invoice. | View details |
GET | /documents/attachments | Retrieves files related to the invoice. | View details |
POST | /documents/processed | Marks document as processed in ERP. | View details |
POST | /documents/status | Updates invoice status after ERP delivery. | View details |
๐งโ๐ผ Suppliers
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
POST | /suppliers | Registers a new supplier in Invoway. | View details |
POST | /suppliers/externalUser | Creates external-authenticated supplier user. | View details |
๐ธ Digital Wallet Integration
Method | Endpoint | Description | Exchange Link |
---|---|---|---|
GET | /digital-wallets/send-payments-orders | Gets pending payment orders to be processed. | View details |
POST | /digital-wallets/receive-payments-orders | Sends results of processed payments. | View details |
๐ค Example Request
curl -X GET "https://cs-invoice-processing-sapi-dev-v1.us-e1.cloudhub.io/api/documents/pending?customerTaxID=800226175&documentTypeCode=11" \
-H "client_id: YOUR_CLIENT_ID"
โ ๏ธ Error Handling
Standard HTTP codes are used:
200 OK
โ Request successful400 Bad Request
โ Missing/invalid input401 Unauthorized
โ Missing or invalid client ID404 Not Found
โ Resource not found500 Internal Server Error
โ Unexpected error
โ ๏ธ Error Handling
Standard HTTP status codes are used for error handling:
200 OK
โ Request was successful400 Bad Request
โ Missing or invalid parameters401 Unauthorized
โ Authentication failed404 Not Found
โ Endpoint or resource not found500 Internal Server Error
โ Unexpected error on the server
๐ Support
For any issues, please contact the API support team:
Integration Services and Applications Coordination
๐ง epalma@fgs.co
๐ Notes
- Documentation last updated: April 2025
- For further updates, refer to the API Exchange Portal