Ingen av slutpunkterna är tillgänglig för interna serviceteams nycklar; offerering och fakturering är för tredjepartsleverantörer som fakturerar en köpare.
Pengar är strängar, i sektioner
Förslag och fakturor delar en radstruktur. Belopp är strängar som måste parsas som tal (“450.00”, inte 450.00 som ett flyttal; avsändare bör formatera med två decimaler och parsa som decimaler). Sektionerna är arbete, material, resa, frakt och övrigt (förslag lägger till inkommen kostnad), var och en med sina egna rader, en skattesats och...TotalBeforeTax, som rullar upp till före-skatt, skatt och efter-skatt-totaler. Rader för resa, frakt och övrigt är enkla { "description", "amount" }-objekt.
Förslag (offerter)
POST /v1/supplier/quote/proposals skapar förslaget direkt i pending-status under din anläggning; det finns inget separat inlämningssteg. Krävs: workOrderId och totalAfterTax.
locationId,buyerFacilityIdochbuyerCompanyIdhärleds från arbetsordern; du kan inte sätta dem.- Osatta skattefält och sektionstotaler blir som standard
"0". requestForProposalIdblir som standard arbetsorderns RFP när det utelämnas.proposalPdfLink, om skickad, måste vara en giltig URL.attachmentstarFileDetailsfrån filuppladdningsslutpunkten.- Att skicka ett
iduppdaterar ett befintligt förslag.
status går från pending till awarded eller declined (avslagsskäl visas i declineNotes). Lista med GET /v1/supplier/quote/proposals (se filtrera listor), läs en med GET /v1/supplier/quote/proposals/{id}.
Fakturor
Livscykeln
Fakturor börjar somdraft (osynliga för köparen), publiceras in i pending, sedan flyttar köparen dem genom approved och processing till paid (eller bestrider dem). Din integration skapar utkastet och publicerar det; från pending och framåt läser du mestadels status.
Skapa utkastet
POST /v1/supplier/invoice/invoices kräver workOrderId; locationId, buyerFacilityId, buyerCompanyId, spendCategoryId och problemTypeId härleds alla från det.
poNumberblir som standard arbetsorderns PO-nummer.serviceCallIdsblir som standard alla servicebesök på arbetsordern när det utelämnas eller är tomt; sätt det uttryckligen när du fakturerar en delmängd av besök.- OpenWrench validerar
taxLineItemsmot fakturavalutans tillåtna skattetyper och avvisar allt annat. För närvarande stödjer endast CAD dem (GST/HST/PST). invoicePDFLink(en giltig URL) blir fakturans enda PDF-post om du är värd för PDF:en själv; de flesta integrationer använder uppladdningsslutpunkten nedan istället.autoPublishOnApprovalväljer denna faktura för auto-publicering när arbetsordern avslutas.- Att spara en faktura kan flytta den associerade arbetsorderns status enligt mappningen faktura-till-arbetsorder-status. Ett spar-nivåvalideringsfel returnerar
406. - Att skicka ett
iduppdaterar en befintlig faktura (i praktiken endast utkast; köpar-sidans statusar är inte dina att redigera).
Ladda upp PDF:en och publicera
POST /v1/supplier/invoice/file/upload_and_publish/{invoiceId} gör båda stegen på en gång: den uppladdade PDF:en (multipart-del file, max 512 MB) blir fakturans enda PDF, och statusen flyttas till pending.
400 om någon förutsättning misslyckas: din anläggning måste äga fakturan, den associerade arbetsordern måste vara i visningsstatus Completed, och köparens konfiguration måste tillåta leverantörsfakturaredigering.
Läsa och stämma av
GET /v1/supplier/invoice/invoices (filtrerbar, se filtrera listor) och GET /v1/supplier/invoice/invoices/{id}. Tredjepartsleverantörer ser maskerade poster med köpar-privata fält bortrensade. Polla status för att driva din AR-huvudbok: approvedAt, processedAt och markedPaidAt tidsstämplar köparens framsteg.
Filtrera listor
GET /v1/supplier/quote/proposals och GET /v1/supplier/invoice/invoices tar offset, limit (standard 10, max 25), sort_by och order, plus filtren nedan. Filter kombineras med AND och kombineras alltid med din nyckels tenant-avgränsning, så du ser bara din anläggnings förslag och fakturor. Ingen av listorna har en räkningsslutpunkt; svarets count är det totala antalet träffar.
Endast förslag
Endast fakturor
Regler för filtervärden:
- Sortering. Båda listorna sorterar efter
createdAt,id,workOrderId,locationId,supplierFacilityIdellerbuyerFacilityId; fakturor sorterar även efterinvoiceTotalAfterTax, och förslag efterupdatedAtochtotalAfterTax. När du sättersort_byblirordersom standardasc, så skickaorder=descför nyast först. Utansort_bykommer fakturor nyast först och förslag iid-ordning (äldst först). Ettsort_bysom inte stöds på förslag faller också tillbaka påid-ordning. - Listor tar kommatecken utan mellanslag. En nyckel i singular (
status) tar ett värde; nyckeln i plural tar en kommaseparerad lista.status=pending,approvedletar efter en enda status med just det namnet och returnerar ingenting. Ett mellanslag efter ett kommatecken kan få anropet att misslyckas. - Ett värde per nyckel. Om du upprepar en parameter används bara den första.
- Datum använder
MM/dd/yyyy HH:mm:ss, till exempel08/01/2026 00:00:00. Värdet är en lokal klocktid som läses i den zon du anger itimezone, eller i UTC om den saknas. Tiden är obligatorisk. Startgränsen är inkluderande från den tid du skickar. Slutgränsen täcker hela slutdagen i den zonen: OpenWrench ersätter dess tid med 23:59:59. URL-koda värdet. Lägg inte till en offset som-05:00i värdet: OpenWrench ignorerar den. - Ett datum som inte kan tolkas returnerar
400medInvalid <key>. Expected format MM/dd/yyyy HH:mm:ss. Det gäller även ISO 8601-värden (2026-10-09T00:00:00), datum utan tid (10/09/2026) och värden som bara består av mellanslag. OpenWrench läser fortfarande ett tomt värde som 1 januari 1970. timezonetar ett IANA-zonnamn, somAmerica/ChicagoellerUTC. Fasta offset (-05:00,GMT-5), förkortningar (CST) och okända namn returnerar400. Se Datumformat för sommartid.- Värden måste vara välformade. Ett icke-numeriskt id, eller ett booleskt värde annat än
trueellerfalse, kan få anropet att misslyckas med500istället för400. - Okända filter ignoreras, och din tenant-avgränsning kan inte åsidosättas:
supplierFacilityIdsätts alltid från din API-nyckel.
End-to-end-faktureringsflöde
- Arbetsordern når offereringsfasen: skicka in ett förslag, vänta på
awarded. - Slutför arbetet via utcheckning från servicebesök.
- Skapa fakturautkastet; generera din PDF.
- När arbetsordern visar Completed,
upload_and_publish. - Polla fakturastatus tills
paidoch stäm av motmarkedPaidAt.